Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/util/TextTag.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/TextTag.java
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
equal
deleted
inserted
replaced
| -1:000000000000 | 0:959103a6100f |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved. | |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 * | |
| 5 * This code is free software; you can redistribute it and/or modify it | |
| 6 * under the terms of the GNU General Public License version 2 only, as | |
| 7 * published by the Free Software Foundation. Oracle designates this | |
| 8 * particular file as subject to the "Classpath" exception as provided | |
| 9 * by Oracle in the LICENSE file that accompanied this code. | |
| 10 * | |
| 11 * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 * accompanied this code). | |
| 16 * | |
| 17 * You should have received a copy of the GNU General Public License version | |
| 18 * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 * | |
| 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | |
| 22 * or visit www.oracle.com if you need additional information or have any | |
| 23 * questions. | |
| 24 */ | |
| 25 package com.sun.tools.doclets.internal.toolkit.util; | |
| 26 import com.sun.javadoc.*; | |
| 27 | |
| 28 | |
| 29 /** | |
| 30 * A tag that holds nothing but plain text. This is useful for passing | |
| 31 * text to methods that only accept inline tags as a parameter. | |
| 32 * | |
| 33 * <p><b>This is NOT part of any supported API. | |
| 34 * If you write code that depends on this, you do so at your own risk. | |
| 35 * This code and its internal interfaces are subject to change or | |
| 36 * deletion without notice.</b> | |
| 37 * | |
| 38 * @author Jamie Ho | |
| 39 * @since 1.5 | |
| 40 */ | |
| 41 public class TextTag implements Tag { | |
| 42 protected final String text; | |
| 43 protected final String name = "Text"; | |
| 44 protected final Doc holder; | |
| 45 | |
| 46 /** | |
| 47 * Constructor | |
| 48 */ | |
| 49 public TextTag(Doc holder, String text) { | |
| 50 super(); | |
| 51 this.holder = holder; | |
| 52 this.text = text; | |
| 53 } | |
| 54 | |
| 55 /** | |
| 56 * {@inheritDoc} | |
| 57 */ | |
| 58 public String name() { | |
| 59 return name; | |
| 60 } | |
| 61 | |
| 62 /** | |
| 63 * {@inheritDoc} | |
| 64 */ | |
| 65 public Doc holder() { | |
| 66 return holder; | |
| 67 } | |
| 68 | |
| 69 /** | |
| 70 * {@inheritDoc} | |
| 71 */ | |
| 72 public String kind() { | |
| 73 return name; | |
| 74 } | |
| 75 | |
| 76 /** | |
| 77 * {@inheritDoc} | |
| 78 */ | |
| 79 public String text() { | |
| 80 return text; | |
| 81 } | |
| 82 | |
| 83 /** | |
| 84 * {@inheritDoc} | |
| 85 */ | |
| 86 public String toString() { | |
| 87 return name + ":" + text; | |
| 88 } | |
| 89 | |
| 90 /** | |
| 91 * {@inheritDoc} | |
| 92 */ | |
| 93 public Tag[] inlineTags() { | |
| 94 return new Tag[] {this}; | |
| 95 } | |
| 96 | |
| 97 /** | |
| 98 * {@inheritDoc} | |
| 99 */ | |
| 100 public Tag[] firstSentenceTags() { | |
| 101 return new Tag[] {this}; | |
| 102 } | |
| 103 | |
| 104 /** | |
| 105 * {@inheritDoc} | |
| 106 */ | |
| 107 public SourcePosition position() { | |
| 108 return holder.position(); | |
| 109 } | |
| 110 } |
