• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/TextTag.java@959103a6100f (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/TextTag.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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