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