com.openpojo.reflection

Interface PojoMethod

All Superinterfaces:

Annotatable, PojoElement

All Known Implementing Classes:

PojoMethodImpl

public interface PojoMethod
extends PojoElement

This class encapsulates the meta data definition of a method on a class.

Author:

oshoukry

Method Summary

Modifier and Type	Method and Description
java.lang.reflect.Type[]	getGenericParameterTypes() Get the method generic parameter types Note: Do not use, still in experimental mode.
java.lang.Class<?>[]	getParameterTypes() Get the method parameters.
java.util.List<PojoParameter>	getPojoParameters() Get method parameters as PojoParameters.
java.lang.Class<?>	getReturnType()
java.lang.Object	invoke(java.lang.Object instance, java.lang.Object... parameters) Invokes the underlying method represented by this Method object, on the specified object with the specified parameters.
boolean	isAbstract()
boolean	isConstructor()
boolean	isFinal()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
boolean	isSynthetic()

Methods inherited from interface com.openpojo.reflection.PojoElement

getName

Methods inherited from interface com.openpojo.reflection.Annotatable

getAnnotation, getAnnotations

Method Detail

invoke

java.lang.Object invoke(java.lang.Object instance,
                        java.lang.Object... parameters)

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 instance argument is ignored. It may be null. If the number of formal parameters required by the underlying method is 0, the supplied parameters array may be of length 0 or null. 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. However, if the value has the type of an array of a primitive type, the elements of the array are not wrapped in objects; in other words, an array of primitive type is returned. If the underlying method return type is void, the invocation returns null. note: If an exception occurs, it will be thrown as ReflectionException.

Parameters:

instance - The class instance to invoke the method on.

parameters - The parameters to pass to the method upon invocation.

Returns:

Value returned by the underlying method.

getPojoParameters

java.util.List<PojoParameter> getPojoParameters()

Get method parameters as PojoParameters. If method doesn't have any parameters an empty list is returned.

Returns:

a List of PojoParameters.

getParameterTypes

java.lang.Class<?>[] getParameterTypes()

Get the method parameters.

Returns:

An array of parameterTypes.

getGenericParameterTypes

java.lang.reflect.Type[] getGenericParameterTypes()

Get the method generic parameter types Note: Do not use, still in experimental mode.

Returns:

An array of generic parameter types.

isFinal

boolean isFinal()

Returns:

True if this PojoMethod is final-ly defined on the enclosing class.

isSynthetic

boolean isSynthetic()

Returns:

true if this PojoMethod is synthetic (i.e. jdk compiler generated).

isStatic

boolean isStatic()

Returns:

True if this PojoMethod is static-ly defined on the enclosing class.

isPrivate

boolean isPrivate()

Returns:

True if this PojoMethod is private-ly defined on the enclosing class.

isProtected

boolean isProtected()

Returns:

True if this PojoMethod is protected-ly defined on the enclosing class.

isPublic

boolean isPublic()

Returns:

True if this PojoMethod is public-ly defined on the enclosing class.

isConstructor

boolean isConstructor()

Returns:

True if this method is a constructor method and returns a new instance.

isAbstract

boolean isAbstract()

Returns:

True if this method is abstract-ly defined on the enclosing class.

getReturnType

java.lang.Class<?> getReturnType()

Returns:

Returns the return type.