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

src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java@93012e2a5d1d (annotated)

src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 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
aoqi@0	26	package com.sun.tools.javadoc;
aoqi@0	27
aoqi@0	28	import java.util.regex.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31
aoqi@0	32	/**
aoqi@0	33	* Represents an @param documentation tag.
aoqi@0	34	* Parses and stores the name and comment parts of the parameter tag.
aoqi@0	35	*
aoqi@0	36	* <p><b>This is NOT part of any supported API.
aoqi@0	37	* If you write code that depends on this, you do so at your own risk.
aoqi@0	38	* This code and its internal interfaces are subject to change or
aoqi@0	39	* deletion without notice.</b>
aoqi@0	40	*
aoqi@0	41	* @author Robert Field
aoqi@0	42	*
aoqi@0	43	*/
aoqi@0	44	class ParamTagImpl extends TagImpl implements ParamTag {
aoqi@0	45
aoqi@0	46	private static final Pattern typeParamRE = Pattern.compile("<([^<>]+)>");
aoqi@0	47
aoqi@0	48	private final String parameterName;
aoqi@0	49	private final String parameterComment;
aoqi@0	50	private final boolean isTypeParameter;
aoqi@0	51
aoqi@0	52	/**
aoqi@0	53	* Cached inline tags.
aoqi@0	54	*/
aoqi@0	55	private Tag[] inlineTags;
aoqi@0	56
aoqi@0	57	ParamTagImpl(DocImpl holder, String name, String text) {
aoqi@0	58	super(holder, name, text);
aoqi@0	59	String[] sa = divideAtWhite();
aoqi@0	60
aoqi@0	61	Matcher m = typeParamRE.matcher(sa[0]);
aoqi@0	62	isTypeParameter = m.matches();
aoqi@0	63	parameterName = isTypeParameter ? m.group(1) : sa[0];
aoqi@0	64	parameterComment = sa[1];
aoqi@0	65	}
aoqi@0	66
aoqi@0	67	/**
aoqi@0	68	* Return the parameter name.
aoqi@0	69	*/
aoqi@0	70	public String parameterName() {
aoqi@0	71	return parameterName;
aoqi@0	72	}
aoqi@0	73
aoqi@0	74	/**
aoqi@0	75	* Return the parameter comment.
aoqi@0	76	*/
aoqi@0	77	public String parameterComment() {
aoqi@0	78	return parameterComment;
aoqi@0	79	}
aoqi@0	80
aoqi@0	81	/**
aoqi@0	82	* Return the kind of this tag.
aoqi@0	83	*/
aoqi@0	84	@Override
aoqi@0	85	public String kind() {
aoqi@0	86	return "@param";
aoqi@0	87	}
aoqi@0	88
aoqi@0	89	/**
aoqi@0	90	* Return true if this ParamTag corresponds to a type parameter.
aoqi@0	91	*/
aoqi@0	92	public boolean isTypeParameter() {
aoqi@0	93	return isTypeParameter;
aoqi@0	94	}
aoqi@0	95
aoqi@0	96	/**
aoqi@0	97	* convert this object to a string.
aoqi@0	98	*/
aoqi@0	99	@Override
aoqi@0	100	public String toString() {
aoqi@0	101	return name + ":" + text;
aoqi@0	102	}
aoqi@0	103
aoqi@0	104	/**
aoqi@0	105	* For the parameter comment with embedded @link tags return the array of
aoqi@0	106	* TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
aoqi@0	107	*
aoqi@0	108	* @return TagImpl[] Array of tags with inline SeeTagImpls.
aoqi@0	109	* @see TagImpl#inlineTags()
aoqi@0	110	* @see ThrowsTagImpl#inlineTags()
aoqi@0	111	*/
aoqi@0	112	@Override
aoqi@0	113	public Tag[] inlineTags() {
aoqi@0	114	if (inlineTags == null) {
aoqi@0	115	inlineTags = Comment.getInlineTags(holder, parameterComment);
aoqi@0	116	}
aoqi@0	117	return inlineTags;
aoqi@0	118	}
aoqi@0	119	}