duke@1: /*
jjg@1358:  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import java.util.regex.*;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * Represents an @param documentation tag.
duke@1:  * Parses and stores the name and comment parts of the parameter tag.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @author Robert Field
duke@1:  *
duke@1:  */
duke@1: class ParamTagImpl extends TagImpl implements ParamTag {
duke@1: 
jjg@1410:     private static final Pattern typeParamRE = Pattern.compile("<([^<>]+)>");
duke@1: 
duke@1:     private final String parameterName;
duke@1:     private final String parameterComment;
duke@1:     private final boolean isTypeParameter;
duke@1: 
ksrini@1053:     /**
ksrini@1053:      * Cached inline tags.
ksrini@1053:      */
ksrini@1053:     private Tag[] inlineTags;
ksrini@1053: 
duke@1:     ParamTagImpl(DocImpl holder, String name, String text) {
duke@1:         super(holder, name, text);
duke@1:         String[] sa = divideAtWhite();
duke@1: 
duke@1:         Matcher m = typeParamRE.matcher(sa[0]);
duke@1:         isTypeParameter = m.matches();
duke@1:         parameterName = isTypeParameter ? m.group(1) : sa[0];
duke@1:         parameterComment = sa[1];
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the parameter name.
duke@1:      */
duke@1:     public String parameterName() {
duke@1:         return parameterName;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the parameter comment.
duke@1:      */
duke@1:     public String parameterComment() {
duke@1:         return parameterComment;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the kind of this tag.
duke@1:      */
ksrini@1053:     @Override
duke@1:     public String kind() {
duke@1:         return "@param";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this ParamTag corresponds to a type parameter.
duke@1:      */
duke@1:     public boolean isTypeParameter() {
duke@1:         return isTypeParameter;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * convert this object to a string.
duke@1:      */
ksrini@1053:     @Override
duke@1:     public String toString() {
duke@1:         return name + ":" + text;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * For the parameter comment with embedded @link tags return the array of
duke@1:      * TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
duke@1:      *
duke@1:      * @return TagImpl[] Array of tags with inline SeeTagImpls.
jjg@1358:      * @see TagImpl#inlineTags()
jjg@1358:      * @see ThrowsTagImpl#inlineTags()
duke@1:      */
ksrini@1053:     @Override
duke@1:     public Tag[] inlineTags() {
ksrini@1053:         if (inlineTags == null) {
ksrini@1053:             inlineTags = Comment.getInlineTags(holder, parameterComment);
ksrini@1053:         }
ksrini@1053:         return inlineTags;
duke@1:     }
duke@1: }