java::lang::reflect::Method Class Reference

A Method provides information about, and access to, a single method on a class or interface. More...

#include <java_lang_reflect_Method.h>

Inheritance diagram for java::lang::reflect::Method:

[legend]Collaboration diagram for java::lang::reflect::Method:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::reflect::Method >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::reflect::Method > >	array2D
Public Member Functions
bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this Method against the specified object.
::java::lang::Class	getDeclaringClass (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the Class object representing the class or interface that declares the method represented by this Method object.
::xmog_java_array_template< ::java::lang::Class >	getExceptionTypes (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of Class objects that represent the types of the exceptions declared to be thrown by the underlying method represented by this Method object.
jint	getModifiers (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the Java language modifiers for the method represented by this Method object, as an integer.
::java::lang::String	getName (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the name of the method represented by this Method object, as a String.
::xmog_java_array_template< ::java::lang::Class >	getParameterTypes (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method represented by this Method object.
::java::lang::Class	getReturnType (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a Class object that represents the formal return type of the method represented by this Method object.
jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hashcode for this Method.
::java::lang::Object	invoke (const ::java::lang::Object &obj, const ::xmog_java_array_template< ::java::lang::Object > &args,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Invokes the underlying method represented by this Method object, on the specified object with the specified parameters.
	Method (const ::java::lang::Class &declaringClass, const ::java::lang::String &name, const ::xmog_java_array_template< ::java::lang::Class > &parameterTypes, const ::java::lang::Class &returnType, const ::xmog_java_array_template< ::java::lang::Class > &checkedExceptions, jint modifiers, jint slot,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Package-private constructor used by ReflectAccess to enable instantiation of these objects in Java code from the java.lang package via sun.reflect.LangReflectAccess.
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string describing this Method.

---

Detailed Description

A Method provides information about, and access to, a single method on a class or interface.

The reflected method may be a class method or an instance method (including an abstract method).

A Method permits widening conversions to occur when matching the actual parameters to invokewith the underlying method's formal parameters, but it throws an IllegalArgumentException if a narrowing conversion would occur.

Author:

Kenneth Russell

Nakul Saraiya

---

Constructor & Destructor Documentation

java::lang::reflect::Method::Method (  const ::java::lang::Class &  declaringClass, const ::java::lang::String &  name, const ::xmog_java_array_template< ::java::lang::Class > &  parameterTypes, const ::java::lang::Class &  returnType, const ::xmog_java_array_template< ::java::lang::Class > &  checkedExceptions, jint  modifiers, jint  slot, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Package-private constructor used by ReflectAccess to enable instantiation of these objects in Java code from the java.lang package via sun.reflect.LangReflectAccess. Parameters: declaringClass  a reference to an outer class instance. name  a reference to an outer class instance. parameterTypes  a reference to an outer class instance. returnType  a reference to an outer class instance. checkedExceptions  a reference to an outer class instance. modifiers  a reference to an outer class instance. slot  a reference to an outer class instance. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

bool java::lang::reflect::Method::equals (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Compares this Method against the specified object. Returns true if the objects are the same. Two Methods are the same if they were declared by the same class and have the same name and formal parameter types and return type. Parameters: obj  a reference to an outer class instance. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

::java::lang::Class java::lang::reflect::Method::getDeclaringClass (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the Class object representing the class or interface that declares the method represented by this Method object. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

::xmog_java_array_template< ::java::lang::Class > java::lang::reflect::Method::getExceptionTypes (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns an array of Class objects that represent the types of the exceptions declared to be thrown by the underlying method represented by this Method object. Returns an array of length 0 if the method declares no exceptions in its throws clause. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the exception types declared as being thrown by the method this object represents

jint java::lang::reflect::Method::getModifiers (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the Java language modifiers for the method represented by this Method object, as an integer. The Modifier class should be used to decode the modifiers. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

::java::lang::String java::lang::reflect::Method::getName (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the name of the method represented by this Method object, as a String. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::reflect::Member.

::xmog_java_array_template< ::java::lang::Class > java::lang::reflect::Method::getParameterTypes (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method represented by this Method object. Returns an array of length 0 if the underlying method takes no parameters. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the parameter types for the method this object represents

::java::lang::Class java::lang::reflect::Method::getReturnType (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a Class object that represents the formal return type of the method represented by this Method object. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the return type for the method this object represents

jint java::lang::reflect::Method::hashCode (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns a hashcode for this Method. The hashcode is computed as the exclusive-or of the hashcodes for the underlying method's declaring class name and the method's name. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

::java::lang::Object java::lang::reflect::Method::invoke (  const ::java::lang::Object &  obj, const ::xmog_java_array_template< ::java::lang::Object > &  args, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Invokes the underlying method represented by this Method object, on the specified object with the specified parameters. Individual parameters are automatically unwrapped to match primitive formal parameters, and both primitive and reference parameters are subject to method invocation conversions as necessary. If the underlying method is static, then the specified obj argument is ignored. It may be null. If the number of formal parameters required by the underlying method is 0, the supplied args array may be of length 0 or null. If the underlying method is an instance method, it is invoked using dynamic method lookup as documented in The Java Language Specification, Second Edition, section 15.12.4.4; in particular, overriding based on the runtime type of the target object will occur. If the underlying method is static, the class that declared the method is initialized if it has not already been initialized. If the method completes normally, the value it returns is returned to the caller of invoke; if the value has a primitive type, it is first appropriately wrapped in an object. If the underlying method return type is void, the invocation returns null. Parameters: obj  the object the underlying method is invoked from args  the arguments used for the method call p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the result of dispatching the method represented by this object on obj with parameters args

::java::lang::String java::lang::reflect::Method::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns a string describing this Method. The string is formatted as the method access modifiers, if any, followed by the method return type, followed by a space, followed by the class declaring the method, followed by a period, followed by the method name, followed by a parenthesized, comma-separated list of the method's formal parameter types. If the method throws checked exceptions, the parameter list is followed by a space, followed by the word throws followed by a comma-separated list of the thrown exception types. For example: public boolean java.lang.Object.equals(java.lang.Object) The access modifiers are placed in canonical order as specified by "The Java Language Specification". This is public, protected or private first, and then other modifiers in the following order: abstract, static, final, synchronized native. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

---

The documentation for this class was generated from the following file:

• java_lang_reflect_Method.h

---