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