1 /* 2 * Copyright (c) 1998, 2004, 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 import com.google.doclava.annotation.Unused; 29 import com.google.doclava.annotation.Used; 30 31 /** 32 * Parameter information. 33 * This includes a parameter type and parameter name. 34 * 35 * @author Robert Field 36 */ 37 public interface Parameter { 38 39 /** 40 * Get the type of this parameter. 41 */ 42 @Used type()43 Type type(); 44 45 /** 46 * Get local name of this parameter. 47 * For example if parameter is the short 'index', returns "index". 48 */ 49 @Used name()50 String name(); 51 52 /** 53 * Get type name of this parameter. 54 * For example if parameter is the short 'index', returns "short". 55 * <p> 56 * This method returns a complete string 57 * representation of the type, including the dimensions of arrays and 58 * the type arguments of parameterized types. Names are qualified. 59 */ 60 @Used typeName()61 String typeName(); 62 63 /** 64 * Returns a string representation of the parameter. 65 * <p> 66 * For example if parameter is the short 'index', returns "short index". 67 * 68 * @return type and parameter name of this parameter. 69 */ 70 @Unused toString()71 String toString(); 72 73 /** 74 * Get the annotations of this parameter. 75 * Return an empty array if there are none. 76 * 77 * @return the annotations of this parameter. 78 * @since 1.5 79 */ 80 @Used annotations()81 AnnotationDesc[] annotations(); 82 } 83