ExecutableMemberDoc


1   /*
2    * @(#)ExecutableMemberDoc.java 1.8 03/12/19
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   * Represents a method or constructor of a java class.
12   *
13   * @since JDK1.2
14   * @author Robert Field
15   */
16  public interface ExecutableMemberDoc extends MemberDoc {
17  
18      /**
19       * Return exceptions this method or constructor throws.
20       * If the type of the exception is a type variable, return the
21       * <code>ClassDoc</code> of its erasure.
22       *
23       * <p> <i>The <code>thrownExceptions</code> method cannot
24       * accommodate certain generic type constructs.  The
25       * <code>thrownExceptionTypes</code> method should be used
26       * instead.</i>
27       *
28       * @return an array of ClassDoc[] representing the exceptions
29       *         thrown by this method.
30       * @see #thrownExceptionTypes
31       */
32      ClassDoc[] thrownExceptions();
33  
34      /**
35       * Return exceptions this method or constructor throws.
36       *
37       * @return an array representing the exceptions thrown by this method.
38       *         Each array element is either a <code>ClassDoc</code> or a
39       *         <code>TypeVariable</code>.
40       * @since 1.5
41       */
42      Type[] thrownExceptionTypes();
43  
44      /**
45       * Return true if this method is native
46       */
47      boolean isNative();
48  
49      /**
50       * Return true if this method is synchronized
51       */
52      boolean isSynchronized();
53  
54      /**
55       * Return true if this method was declared to take a variable number
56       * of arguments.
57       *
58       * @since 1.5
59       */
60      public boolean isVarArgs();
61  
62      /**
63       * Get argument information.
64       *
65       * @see Parameter
66       *
67       * @return an array of Parameter, one element per argument
68       * in the order the arguments are present.
69       */
70      Parameter[] parameters();
71  
72      /**
73       * Return the throws tags in this method.
74       *
75       * @return an array of ThrowTag containing all <code>&#64exception</code>
76       * and <code>&#64throws</code> tags.
77       */
78      ThrowsTag[] throwsTags();
79  
80      /**
81       * Return the param tags in this method, excluding the type
82       * parameter tags.
83       *
84       * @return an array of ParamTag containing all <code>&#64param</code> tags
85       * corresponding to the parameters of this method.
86       */
87      ParamTag[] paramTags();
88  
89      /**
90       * Return the type parameter tags in this method.
91       *
92       * @return an array of ParamTag containing all <code>&#64param</code> tags
93       * corresponding to the type parameters of this method.
94       * @since 1.5
95       */
96      ParamTag[] typeParamTags();
97  
98      /**
99       * Get the signature. It is the parameter list, type is qualified.
100      *      For instance, for a method <code>mymethod(String x, int y)</code>,
101      *      it will return <code>(java.lang.String,int)</code>.
102      */
103     String   signature();
104 
105     /**
106      * get flat signature.  all types are not qualified.
107      *      return a String, which is the flat signiture of this member.
108      *      It is the parameter list, type is not qualified.
109      *      For instance, for a method <code>mymethod(String x, int y)</code>,
110      *      it will return <code>(String, int)</code>.
111      */
112     String   flatSignature();
113 
114     /**
115      * Return the formal type parameters of this method or constructor.
116      * Return an empty array if this method or constructor is not generic.
117      *
118      * @return the formal type parameters of this method or constructor.
119      * @since 1.5
120      */
121     TypeVariable[] typeParameters();
122 }
123
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags