1 /*

     2  * Copyright (c) 1998, 2018, 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 

    26 package com.sun.javadoc;

    27 

    28 /**

    29  * Parameter information.

    30  * This includes a parameter type and parameter name.

    31  *

    32  * @author Robert Field

    33  *

    34  * @deprecated

    35  *   The declarations in this package have been superseded by those

    36  *   in the package {@code jdk.javadoc.doclet}.

    37  *   For more information, see the <i>Migration Guide</i> in the documentation for that package.

    38  */

    39 @Deprecated(since="9", forRemoval=true)

    40 @SuppressWarnings("removal")

    41 public interface Parameter {

    42 

    43     /**

    44      * Get the type of this parameter.

    45      *

    46      * @return the type of this parameter.

    47      */

    48     Type type();

    49 

    50     /**

    51      * Get local name of this parameter.

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

    53      *

    54      * @return the name of this parameter as a string.

    55      */

    56     String name();

    57 

    58     /**

    59      * Get type name of this parameter.

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

    61      * <p>

    62      * This method returns a complete string

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

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

    65      *

    66      * @return a complete string representation of the type.

    67      */

    68     String typeName();

    69 

    70     /**

    71      * Returns a string representation of the parameter.

    72      * <p>

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

    74      *

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

    76      */

    77     String toString();

    78 

    79     /**

    80      * Get the annotations of this parameter.

    81      * Return an empty array if there are none.

    82      *

    83      * @return the annotations of this parameter.

    84      * @since 1.5

    85      */

    86     AnnotationDesc[] annotations();

    87 }