jdk8-mips64-public/langtools: src/share/classes/com/sun/javadoc/Parameter.java@9a66ca7c79fa

     1 /*

     2  * Copyright 1998-2004 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    26 package com.sun.javadoc;

    28 /**

    29  * Parameter information.

    30  * This includes a parameter type and parameter name.

    31  *

    32  * @author Robert Field

    33  */

    34 public interface Parameter {

    36     /**

    37      * Get the type of this parameter.

    38      */

    39     Type type();

    41     /**

    42      * Get local name of this parameter.

    43      * For example if parameter is the short 'index', returns "index".

    44      */

    45     String name();

    47     /**

    48      * Get type name of this parameter.

    49      * For example if parameter is the short 'index', returns "short".

    50      * <p>

    51      * This method returns a complete string

    52      * representation of the type, including the dimensions of arrays and

    53      * the type arguments of parameterized types.  Names are qualified.

    54      */

    55     String typeName();

    57     /**

    58      * Returns a string representation of the parameter.

    59      * <p>

    60      * For example if parameter is the short 'index', returns "short index".

    61      *

    62      * @return type and parameter name of this parameter.

    63      */

    64     String toString();

    66     /**

    67      * Get the annotations of this parameter.

    68      * Return an empty array if there are none.

    69      *

    70      * @return the annotations of this parameter.

    71      * @since 1.5

    72      */

    73     AnnotationDesc[] annotations();

    74 }

Mercurial > jdk8-mips64-public > langtools / file revision