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

Thu, 06 Oct 2011 18:39:31 +0100

author
mcimadamore
date
Thu, 06 Oct 2011 18:39:31 +0100
changeset 1103
47147081d5b4
parent 1053
0d8edba73d70
child 1358
fc123bdeddb8
permissions
-rw-r--r--

7090499: missing rawtypes warnings in anonymous inner class
Summary: javac does not detect raw types inside anonymous inner classes
Reviewed-by: jjg

duke@1 1 /*
ksrini@1053 2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. 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
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle 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 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * 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
ksrini@1053 47 /**
ksrini@1053 48 * Cached inline tags.
ksrini@1053 49 */
ksrini@1053 50 private Tag[] inlineTags;
ksrini@1053 51
duke@1 52 ParamTagImpl(DocImpl holder, String name, String text) {
duke@1 53 super(holder, name, text);
duke@1 54 String[] sa = divideAtWhite();
duke@1 55
duke@1 56 Matcher m = typeParamRE.matcher(sa[0]);
duke@1 57 isTypeParameter = m.matches();
duke@1 58 parameterName = isTypeParameter ? m.group(1) : sa[0];
duke@1 59 parameterComment = sa[1];
duke@1 60 }
duke@1 61
duke@1 62 /**
duke@1 63 * Return the parameter name.
duke@1 64 */
duke@1 65 public String parameterName() {
duke@1 66 return parameterName;
duke@1 67 }
duke@1 68
duke@1 69 /**
duke@1 70 * Return the parameter comment.
duke@1 71 */
duke@1 72 public String parameterComment() {
duke@1 73 return parameterComment;
duke@1 74 }
duke@1 75
duke@1 76 /**
duke@1 77 * Return the kind of this tag.
duke@1 78 */
ksrini@1053 79 @Override
duke@1 80 public String kind() {
duke@1 81 return "@param";
duke@1 82 }
duke@1 83
duke@1 84 /**
duke@1 85 * Return true if this ParamTag corresponds to a type parameter.
duke@1 86 */
duke@1 87 public boolean isTypeParameter() {
duke@1 88 return isTypeParameter;
duke@1 89 }
duke@1 90
duke@1 91 /**
duke@1 92 * convert this object to a string.
duke@1 93 */
ksrini@1053 94 @Override
duke@1 95 public String toString() {
duke@1 96 return name + ":" + text;
duke@1 97 }
duke@1 98
duke@1 99 /**
duke@1 100 * For the parameter comment with embedded @link tags return the array of
duke@1 101 * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
duke@1 102 *
duke@1 103 * @return TagImpl[] Array of tags with inline SeeTagImpls.
duke@1 104 * @see TagImpl#inlineTagImpls()
duke@1 105 * @see ThrowsTagImpl#inlineTagImpls()
duke@1 106 */
ksrini@1053 107 @Override
duke@1 108 public Tag[] inlineTags() {
ksrini@1053 109 if (inlineTags == null) {
ksrini@1053 110 inlineTags = Comment.getInlineTags(holder, parameterComment);
ksrini@1053 111 }
ksrini@1053 112 return inlineTags;
duke@1 113 }
duke@1 114 }

mercurial