1/* 2 * Copyright (c) 1997, 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.javadoc.main; 27 28import java.util.regex.*; 29 30import 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 45class ParamTagImpl extends TagImpl implements ParamTag { 46 47 private static final Pattern typeParamRE = Pattern.compile("<([^<>]+)>"); 48 49 private final String parameterName; 50 private final String parameterComment; 51 private final boolean isTypeParameter; 52 53 /** 54 * Cached inline tags. 55 */ 56 private Tag[] inlineTags; 57 58 ParamTagImpl(DocImpl holder, String name, String text) { 59 super(holder, name, text); 60 String[] sa = divideAtWhite(); 61 62 Matcher m = typeParamRE.matcher(sa[0]); 63 isTypeParameter = m.matches(); 64 parameterName = isTypeParameter ? m.group(1) : sa[0]; 65 parameterComment = sa[1]; 66 } 67 68 /** 69 * Return the parameter name. 70 */ 71 public String parameterName() { 72 return parameterName; 73 } 74 75 /** 76 * Return the parameter comment. 77 */ 78 public String parameterComment() { 79 return parameterComment; 80 } 81 82 /** 83 * Return the kind of this tag. 84 */ 85 @Override 86 public String kind() { 87 return "@param"; 88 } 89 90 /** 91 * Return true if this ParamTag corresponds to a type parameter. 92 */ 93 public boolean isTypeParameter() { 94 return isTypeParameter; 95 } 96 97 /** 98 * convert this object to a string. 99 */ 100 @Override 101 public String toString() { 102 return name + ":" + text; 103 } 104 105 /** 106 * For the parameter comment with embedded @link tags return the array of 107 * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s). 108 * 109 * @return TagImpl[] Array of tags with inline SeeTagImpls. 110 * @see TagImpl#inlineTags() 111 * @see ThrowsTagImpl#inlineTags() 112 */ 113 @Override 114 public Tag[] inlineTags() { 115 if (inlineTags == null) { 116 inlineTags = Comment.getInlineTags(holder, parameterComment); 117 } 118 return inlineTags; 119 } 120} 121