duke@1: /*
ohair@554:  * Copyright (c) 1998, 2004, 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.javadoc;
duke@1: 
duke@1: /**
duke@1:  * Parameter information.
duke@1:  * This includes a parameter type and parameter name.
duke@1:  *
duke@1:  * @author Robert Field
duke@1:  */
duke@1: public interface Parameter {
duke@1: 
duke@1:     /**
duke@1:      * Get the type of this parameter.
duke@1:      */
duke@1:     Type type();
duke@1: 
duke@1:     /**
duke@1:      * Get local name of this parameter.
duke@1:      * For example if parameter is the short 'index', returns "index".
duke@1:      */
duke@1:     String name();
duke@1: 
duke@1:     /**
duke@1:      * Get type name of this parameter.
duke@1:      * For example if parameter is the short 'index', returns "short".
duke@1:      * <p>
duke@1:      * This method returns a complete string
duke@1:      * representation of the type, including the dimensions of arrays and
duke@1:      * the type arguments of parameterized types.  Names are qualified.
duke@1:      */
duke@1:     String typeName();
duke@1: 
duke@1:     /**
duke@1:      * Returns a string representation of the parameter.
duke@1:      * <p>
duke@1:      * For example if parameter is the short 'index', returns "short index".
duke@1:      *
duke@1:      * @return type and parameter name of this parameter.
duke@1:      */
duke@1:     String toString();
duke@1: 
duke@1:     /**
duke@1:      * Get the annotations of this parameter.
duke@1:      * Return an empty array if there are none.
duke@1:      *
duke@1:      * @return the annotations of this parameter.
duke@1:      * @since 1.5
duke@1:      */
duke@1:     AnnotationDesc[] annotations();
duke@1: }