com.comphenix.protocol.reflect

Class MethodInfo

java.lang.Object

com.comphenix.protocol.reflect.MethodInfo

All Implemented Interfaces:

java.lang.reflect.GenericDeclaration, java.lang.reflect.Member

public abstract class MethodInfo
extends java.lang.Object
implements java.lang.reflect.GenericDeclaration, java.lang.reflect.Member

Represents a method or a constructor.

Author:

Kristian

Field Summary

Fields inherited from interface java.lang.reflect.Member

DECLARED, PUBLIC

Constructor Summary

Constructors

Constructor and Description
MethodInfo()

Method Summary

Methods

Modifier and Type	Method and Description
static MethodInfo	fromConstructor(java.lang.reflect.Constructor<?> constructor) Wraps a constructor as a method information object.
static java.util.List<MethodInfo>	fromConstructors(java.util.Collection<java.lang.reflect.Constructor<?>> constructors) Construct a list of method infos from a given collection of constructors.
static java.util.Collection<MethodInfo>	fromConstructors(java.lang.reflect.Constructor<?>[] constructors) Construct a list of method infos from a given array of constructors.
static MethodInfo	fromMethod(java.lang.reflect.Method method) Wraps a method as a MethodInfo object.
static java.util.List<MethodInfo>	fromMethods(java.util.Collection<java.lang.reflect.Method> methods) Construct a list of method infos from a given collection of methods.
static java.util.Collection<MethodInfo>	fromMethods(java.lang.reflect.Method[] methods) Construct a list of method infos from a given array of methods.
abstract java.lang.Class<?>[]	getExceptionTypes() Returns an array of Class objects that represent the types of the exceptions declared to be thrown by the underlying method or constructor represented by this MethodInfo object.
abstract java.lang.Class<?>[]	getParameterTypes() Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method or constructor represented by this MethodInfo object.
abstract java.lang.Class<?>	getReturnType() Returns a Class object that represents the formal return type of the method or constructor represented by this MethodInfo object.
abstract boolean	isConstructor() Determine if this is a constructor or not.
abstract java.lang.String	toGenericString() Returns a string describing this method or constructor, including type parameters.
java.lang.String	toString() Returns a string describing this method or constructor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.reflect.GenericDeclaration

getTypeParameters

Methods inherited from interface java.lang.reflect.Member

getDeclaringClass, getModifiers, getName, isSynthetic

Constructor Detail

MethodInfo

public MethodInfo()

Method Detail

fromMethod

public static MethodInfo fromMethod(java.lang.reflect.Method method)

Wraps a method as a MethodInfo object.

Parameters:

method - - the method to wrap.

Returns:

The wrapped method.

fromMethods

public static java.util.Collection<MethodInfo> fromMethods(java.lang.reflect.Method[] methods)

Construct a list of method infos from a given array of methods.

Parameters:

methods - - array of methods.

Returns:

Method info list.

fromMethods

public static java.util.List<MethodInfo> fromMethods(java.util.Collection<java.lang.reflect.Method> methods)

Construct a list of method infos from a given collection of methods.

Parameters:

methods - - list of methods.

Returns:

Method info list.

fromConstructor

public static MethodInfo fromConstructor(java.lang.reflect.Constructor<?> constructor)

Wraps a constructor as a method information object.

Parameters:

constructor - - the constructor to wrap.

Returns:

A wrapped constructor.

fromConstructors

public static java.util.Collection<MethodInfo> fromConstructors(java.lang.reflect.Constructor<?>[] constructors)

Construct a list of method infos from a given array of constructors.

Parameters:

constructors - - array of constructors.

Returns:

Method info list.

fromConstructors

public static java.util.List<MethodInfo> fromConstructors(java.util.Collection<java.lang.reflect.Constructor<?>> constructors)

Construct a list of method infos from a given collection of constructors.

Parameters:

constructors - - list of constructors.

Returns:

Method info list.

toString

public java.lang.String toString()

Returns a string describing this method or constructor

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the object.

See Also:

Method#toString()} or {@link Constructor#toString()}

toGenericString

public abstract java.lang.String toGenericString()

Returns a string describing this method or constructor, including type parameters.

Returns:

A string describing this Method, include type parameters

See Also:

Method#toGenericString()} or {@link Constructor#toGenericString()}

getExceptionTypes

public abstract java.lang.Class<?>[] getExceptionTypes()

Returns an array of Class objects that represent the types of the exceptions declared to be thrown by the underlying method or constructor represented by this MethodInfo object.

Returns:

The exception types declared as being thrown by the method or constructor this object represents.

See Also:

Method#getExceptionTypes()} or {@link Constructor#getExceptionTypes()}

getReturnType

public abstract java.lang.Class<?> getReturnType()

Returns a Class object that represents the formal return type of the method or constructor represented by this MethodInfo object.

This is always Void for constructors.

Returns:

The return value, or Void if a constructor.

See Also:

Method#getReturnType()}

getParameterTypes

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

Returns an array of Class objects that represent the formal parameter types, in declaration order, of the method or constructor represented by this MethodInfo object.

Returns:

The parameter types for the method or constructor this object represents.

See Also:

Method#getParameterTypes()} or {@link Constructor#getParameterTypes()}

isConstructor

public abstract boolean isConstructor()

Determine if this is a constructor or not.

Returns:

TRUE if this represents a constructor, FALSE otherwise.