Parameter


1   /*
2    * @(#)Parameter.java   1.11 04/04/30
3    *
4    * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5    * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6    */
7   
8   package com.sun.javadoc;
9   
10  /**
11   * Parameter information.
12   * This includes a parameter type and parameter name.
13   *
14   * @author Robert Field
15   */
16  public interface Parameter {
17  
18      /**
19       * Get the type of this parameter.
20       */
21      Type type();
22  
23      /**
24       * Get local name of this parameter.
25       * For example if parameter is the short 'index', returns "index".
26       */
27      String   name();
28  
29      /**
30       * Get type name of this parameter.
31       * For example if parameter is the short 'index', returns "short".
32       * <p>
33       * This method returns a complete string
34       * representation of the type, including the dimensions of arrays and
35       * the type arguments of parameterized types.  Names are qualified.
36       */
37      String   typeName();
38  
39      /**
40       * Returns a string representation of the parameter.
41       * <p>
42       * For example if parameter is the short 'index', returns "short index".
43       *
44       * @return type and parameter name of this parameter.
45       */
46      String   toString();
47  
48      /**
49       * Get the annotations of this parameter.
50       * Return an empty array if there are none.
51       *
52       * @return the annotations of this parameter.
53       * @since 1.5
54       */
55      AnnotationDesc[] annotations();
56  }
57  
58  
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags