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
26package com.sun.tools.doclets.internal.toolkit.util;
27import com.sun.javadoc.*;
28
29
30/**
31 * A tag that holds nothing but plain text.  This is useful for passing
32 * text to methods that only accept inline tags as a parameter.
33 *
34 *  <p><b>This is NOT part of any supported API.
35 *  If you write code that depends on this, you do so at your own risk.
36 *  This code and its internal interfaces are subject to change or
37 *  deletion without notice.</b>
38 *
39 * @author Jamie Ho
40 * @since 1.5
41 */
42@Deprecated
43public class TextTag implements Tag {
44    protected final String text;
45    protected final String name = "Text";
46    protected final Doc holder;
47
48    /**
49     *  Constructor
50     */
51    public TextTag(Doc holder, String text) {
52        super();
53        this.holder = holder;
54        this.text = text;
55    }
56
57    /**
58     * {@inheritDoc}
59     */
60    public String name() {
61        return name;
62    }
63
64    /**
65     * {@inheritDoc}
66     */
67    public Doc holder() {
68        return holder;
69    }
70
71    /**
72     * {@inheritDoc}
73     */
74    public String kind() {
75        return name;
76    }
77
78    /**
79     * {@inheritDoc}
80     */
81    public String text() {
82        return text;
83    }
84
85    /**
86     * {@inheritDoc}
87     */
88    public String toString() {
89        return name + ":" + text;
90    }
91
92    /**
93     * {@inheritDoc}
94     */
95    public Tag[] inlineTags() {
96        return new Tag[] {this};
97    }
98
99    /**
100     * {@inheritDoc}
101     */
102    public Tag[] firstSentenceTags() {
103        return new Tag[] {this};
104    }
105
106    /**
107     * {@inheritDoc}
108     */
109    public SourcePosition position() {
110        return holder.position();
111    }
112}
113