Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/tools/javadoc/ParamTagImpl.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 1997-2003 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.util.regex.*; |
| duke@1 | 29 | |
| duke@1 | 30 | import com.sun.javadoc.*; |
| duke@1 | 31 | |
| duke@1 | 32 | /** |
| duke@1 | 33 | * Represents an @param documentation tag. |
| duke@1 | 34 | * Parses and stores the name and comment parts of the parameter tag. |
| duke@1 | 35 | * |
| duke@1 | 36 | * @author Robert Field |
| duke@1 | 37 | * |
| duke@1 | 38 | */ |
| duke@1 | 39 | class ParamTagImpl extends TagImpl implements ParamTag { |
| duke@1 | 40 | |
| duke@1 | 41 | private static Pattern typeParamRE = Pattern.compile("<([^<>]+)>"); |
| duke@1 | 42 | |
| duke@1 | 43 | private final String parameterName; |
| duke@1 | 44 | private final String parameterComment; |
| duke@1 | 45 | private final boolean isTypeParameter; |
| duke@1 | 46 | |
| duke@1 | 47 | ParamTagImpl(DocImpl holder, String name, String text) { |
| duke@1 | 48 | super(holder, name, text); |
| duke@1 | 49 | String[] sa = divideAtWhite(); |
| duke@1 | 50 | |
| duke@1 | 51 | Matcher m = typeParamRE.matcher(sa[0]); |
| duke@1 | 52 | isTypeParameter = m.matches(); |
| duke@1 | 53 | parameterName = isTypeParameter ? m.group(1) : sa[0]; |
| duke@1 | 54 | parameterComment = sa[1]; |
| duke@1 | 55 | } |
| duke@1 | 56 | |
| duke@1 | 57 | /** |
| duke@1 | 58 | * Return the parameter name. |
| duke@1 | 59 | */ |
| duke@1 | 60 | public String parameterName() { |
| duke@1 | 61 | return parameterName; |
| duke@1 | 62 | } |
| duke@1 | 63 | |
| duke@1 | 64 | /** |
| duke@1 | 65 | * Return the parameter comment. |
| duke@1 | 66 | */ |
| duke@1 | 67 | public String parameterComment() { |
| duke@1 | 68 | return parameterComment; |
| duke@1 | 69 | } |
| duke@1 | 70 | |
| duke@1 | 71 | /** |
| duke@1 | 72 | * Return the kind of this tag. |
| duke@1 | 73 | */ |
| duke@1 | 74 | public String kind() { |
| duke@1 | 75 | return "@param"; |
| duke@1 | 76 | } |
| duke@1 | 77 | |
| duke@1 | 78 | /** |
| duke@1 | 79 | * Return true if this ParamTag corresponds to a type parameter. |
| duke@1 | 80 | */ |
| duke@1 | 81 | public boolean isTypeParameter() { |
| duke@1 | 82 | return isTypeParameter; |
| duke@1 | 83 | } |
| duke@1 | 84 | |
| duke@1 | 85 | /** |
| duke@1 | 86 | * convert this object to a string. |
| duke@1 | 87 | */ |
| duke@1 | 88 | public String toString() { |
| duke@1 | 89 | return name + ":" + text; |
| duke@1 | 90 | } |
| duke@1 | 91 | |
| duke@1 | 92 | /** |
| duke@1 | 93 | * For the parameter comment with embedded @link tags return the array of |
| duke@1 | 94 | * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). |
| duke@1 | 95 | * |
| duke@1 | 96 | * @return TagImpl[] Array of tags with inline SeeTagImpls. |
| duke@1 | 97 | * @see TagImpl#inlineTagImpls() |
| duke@1 | 98 | * @see ThrowsTagImpl#inlineTagImpls() |
| duke@1 | 99 | */ |
| duke@1 | 100 | public Tag[] inlineTags() { |
| duke@1 | 101 | return Comment.getInlineTags(holder, parameterComment); |
| duke@1 | 102 | } |
| duke@1 | 103 | } |
