1/* 2 * Copyright (c) 1998, 2014, 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 26package 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 40public interface Parameter { 41 42 /** 43 * Get the type of this parameter. 44 * 45 * @return the type of this parameter. 46 */ 47 Type type(); 48 49 /** 50 * Get local name of this parameter. 51 * For example if parameter is the short 'index', returns "index". 52 * 53 * @return the name of this parameter as a string. 54 */ 55 String name(); 56 57 /** 58 * Get type name of this parameter. 59 * For example if parameter is the short 'index', returns "short". 60 * <p> 61 * This method returns a complete string 62 * representation of the type, including the dimensions of arrays and 63 * the type arguments of parameterized types. Names are qualified. 64 * 65 * @return a complete string representation of the type. 66 */ 67 String typeName(); 68 69 /** 70 * Returns a string representation of the parameter. 71 * <p> 72 * For example if parameter is the short 'index', returns "short index". 73 * 74 * @return type and parameter name of this parameter. 75 */ 76 String toString(); 77 78 /** 79 * Get the annotations of this parameter. 80 * Return an empty array if there are none. 81 * 82 * @return the annotations of this parameter. 83 * @since 1.5 84 */ 85 AnnotationDesc[] annotations(); 86} 87