Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
java.lang.reflect.AccessibleObject
java.lang.reflect.Method
IllegalArgumentException
if
a narrowing conversion would be necessary. You can query for information
on this Method regardless of location, but invocation access may be limited
by Java language access controls. If you can't do it in the compiler, you
can't normally do it here either.
Note: This class returns and accepts types as Classes, even
primitive types; there are Class types defined that represent each
different primitive type. They are java.lang.Boolean.TYPE,
java.lang.Byte.TYPE,
, also available as boolean.class,
byte.class
, etc. These are not to be confused with the
classes java.lang.Boolean, java.lang.Byte
, etc., which are
real classes.
Also note that this is not a serializable class. It is entirely feasible to make it serializable using the Externalizable interface, but this is on Sun, not me.
Member
, Class
, java.lang.Class.getMethod(String,Class[])
, java.lang.Class.getDeclaredMethod(String,Class[])
, Class.getMethods()
, Class.getDeclaredMethods()
Method Summary | |
boolean | |
|
|
Annotation[] |
|
Class |
|
Object |
|
Class[] |
|
Type[] |
|
Type[] |
|
Type |
|
int |
|
String |
|
Annotation[][] | |
Class[] |
|
Class |
|
TypeVariable |
|
int |
|
Object | |
boolean |
|
boolean |
|
boolean |
|
String | |
String |
|
Methods inherited from class java.lang.reflect.AccessibleObject | |
extends Annotation> T getAnnotation , getAnnotations , getDeclaredAnnotations , isAccessible , isAnnotationPresent , setAccessible , setAccessible |
Methods inherited from class java.lang.Object | |
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
public boolean equals(Object obj)
Compare two objects to see if they are semantically equivalent. Two Methods are semantically equivalent if they have the same declaring class, name, and parameter list. This ignores different exception clauses or return types.
- Parameters:
- Returns:
true
if they are equal;false
if not
publicextends Annotation> T getAnnotation (ClassannoClass)
Returns the element's annotation for the specified annotation type, ornull
if no such annotation exists.
- Specified by:
- extends Annotation> T getAnnotation in interface AnnotatedElement
- Overrides:
- extends Annotation> T getAnnotation in interface AccessibleObject
- Parameters:
- Returns:
- this element's annotation for the specified type, or
null
if no such annotation exists.
- Throws:
NullPointerException
- if the annotation class isnull
.
public Annotation[] getDeclaredAnnotations()
Returns all annotations directly defined by the element. If there are no annotations directly associated with the element, then a zero-length array will be returned. The returned array may be modified by the client code, but this will have no effect on the annotation content of this class, and hence no effect on the return value of this method for future callers.
- Specified by:
- getDeclaredAnnotations in interface AnnotatedElement
- Overrides:
- getDeclaredAnnotations in interface AccessibleObject
- Returns:
- the annotations directly defined by the element.
- Since:
- 1.5
public Class getDeclaringClass()
Gets the class that declared this method, or the class where this method is a non-inherited member.
- Specified by:
- getDeclaringClass in interface Member
- Returns:
- the class that declared this member
public Object getDefaultValue()
If this method is an annotation method, returns the default value for the method. If there is no default value, or if the method is not a member of an annotation type, returns null. Primitive types are wrapped.
- Throws:
TypeNotPresentException
- if the method returns a Class, and the class cannot be found
- Since:
- 1.5
public Class[] getExceptionTypes()
Get the exception types this method says it throws, in no particular order. If the method has no throws clause, returns a 0-length array (not null).
- Returns:
- a list of the types in the method's throws clause
public Type[] getGenericExceptionTypes()
Returns an array ofType
objects that represents the exception types declared by this method, in declaration order. An array of size zero is returned if this method declares no exceptions.
- Returns:
- the exception types declared by this method.
- Since:
- 1.5
public Type[] getGenericParameterTypes()
Returns an array ofType
objects that represents the parameter list for this method, in declaration order. An array of size zero is returned if this method takes no parameters.
- Returns:
- a list of the types of the method's parameters
- Since:
- 1.5
public Type getGenericReturnType()
Returns the return type of this method.
- Returns:
- the return type of this method
- Since:
- 1.5
public int getModifiers()
Gets the modifiers this method uses. Use theModifier
class to interpret the values. A method can only have a subset of the following modifiers: public, private, protected, abstract, static, final, synchronized, native, and strictfp.
- Specified by:
- getModifiers in interface Member
- Returns:
- an integer representing the modifiers to this Member
- See Also:
Modifier
public Class[] getParameterTypes()
Get the parameter list for this method, in declaration order. If the method takes no parameters, returns a 0-length array (not null).
- Returns:
- a list of the types of the method's parameters
public Class getReturnType()
Gets the return type of this method.
- Returns:
- the type of this method
public TypeVariable[] getTypeParameters()
Returns an array ofTypeVariable
objects that represents the type variables declared by this constructor, in declaration order. An array of size zero is returned if this class has no type variables.
- Specified by:
- getTypeParameters in interface GenericDeclaration
- Returns:
- the type variables associated with this class.
- Since:
- 1.5
public int hashCode()
Get the hash code for the Method. The Method hash code is the hash code of its name XOR'd with the hash code of its class name.
- Returns:
- the hash code for the object
public Object invoke(Object obj, java.lang.Object... args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException
Invoke the method. Arguments are automatically unwrapped and widened, and the result is automatically wrapped, if needed.If the method is static,
o
will be ignored. Otherwise, the method uses dynamic lookup as described in JLS 15.12.4.4. You cannot mimic the behavior of nonvirtual lookup (as in super.foo()). This means you will get aNullPointerException
ifo
is null, and anIllegalArgumentException
if it is incompatible with the declaring class of the method. If the method takes 0 arguments, you may use null or a 0-length array forargs
.Next, if this Method enforces access control, your runtime context is evaluated, and you may have an
IllegalAccessException
if you could not acces this method in similar compiled code. If the method is static, and its class is uninitialized, you trigger class initialization, which may end in aExceptionInInitializerError
.Finally, the method is invoked. If it completes normally, the return value will be null for a void method, a wrapped object for a primitive return method, or the actual return of an Object method. If it completes abruptly, the exception is wrapped in an
InvocationTargetException
.
- Parameters:
args
- the arguments to the method
- Returns:
- the return value of the method, wrapped in the appropriate wrapper if it is primitive
- Throws:
IllegalAccessException
- if the method could not normally be called by the Java code (i.e. it is not public)IllegalArgumentException
- if the number of arguments is incorrect; if the arguments types are wrong even with a widening conversion; or ifo
is not an instance of the class or interface declaring this methodInvocationTargetException
- if the method throws an exceptionNullPointerException
- ifo
is null and this field requires an instance
public boolean isBridge()
Return true if this method is a bridge method. A bridge method is generated by the compiler in some situations involving generics and inheritance.
- Since:
- 1.5
public boolean isSynthetic()
Return true if this method is synthetic, false otherwise.
- Specified by:
- isSynthetic in interface Member
- Since:
- 1.5
public boolean isVarArgs()
Return true if this is a varargs method, that is if the method takes a variable number of arguments.
- Since:
- 1.5
public String toString()
Get a String representation of the Method. A Method's String representation is "<modifiers> <returntype> <methodname>(<paramtypes>) throws <exceptions>", where everything after ')' is omitted if there are no exceptions.
Example:public static int run(java.lang.Runnable,int)
- Returns:
- the String representation of the Method