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