Class Invokable<T,R>
- Type Parameters:
T- the type that owns this method or constructor.R- the return type of (or supertype thereof) the method or the declaring type of the constructor.
- All Implemented Interfaces:
AnnotatedElement,Member
Method or a Constructor. Convenience API is provided to
make common reflective operation easier to deal with, such as isPublic(), getParameters() etc.
In addition to convenience methods, TypeToken.method(java.lang.reflect.Method) and TypeToken.constructor(java.lang.reflect.Constructor<?>)
will resolve the type parameters of the method or constructor in the context of the owner type,
which may be a subtype of the declaring class. For example:
Method getMethod = List.class.getMethod("get", int.class);
Invokable<List<String>, ?> invokable = new TypeToken<List<String>>() {}.method(getMethod);
assertEquals(TypeToken.of(String.class), invokable.getReturnType()); // Not Object.class!
assertEquals(new TypeToken<List<String>>() {}, invokable.getOwnerType());
Note: earlier versions of this class inherited from AccessibleObject and GenericDeclaration. Since version 31.0 that is no longer
the case. However, most methods from those types are present with the same signature in this
class.
- Since:
- 14.0 (no longer implements
AccessibleObjectorGenericDeclarationsince 31.0) - Author:
- Ben Yu
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic <T> Invokable<T, T> from(Constructor<T> constructor) ReturnsInvokableofconstructor.ReturnsInvokableofmethod.final <A extends Annotation>
@Nullable AgetAnnotation(Class<A> annotationClass) final Annotation[]final Annotation[]final ImmutableList<TypeToken<? extends Throwable>> Returns all declared exception types of thisInvokable.final intfinal StringgetName()Returns the type ofT.final ImmutableList<Parameter> Returns all declared parameters of thisInvokable.Returns the return type of thisInvokable.abstract TypeVariable<?>[]inthashCode()Invokes withreceiveras 'this' andargspassed to the underlying method and returns the return value; or calls the underlying constructor withargsand returns the constructed instance.final booleanReturns true if the method is abstract.final booleanfinal booleanisAnnotationPresent(Class<? extends Annotation> annotationClass) final booleanisFinal()Returnstrueif this method is final, perModifier.isFinal(getModifiers()).final booleanisNative()Returns true if the element is native.abstract booleanReturnstrueif this is an overridable method.final booleanReturns true if the element is package-private.final booleanReturns true if the element is private.final booleanReturns true if the element is protected.final booleanisPublic()Returns true if the element is public.final booleanisStatic()Returns true if the element is static.final booleanReturns true if the method is synchronized.final booleanabstract booleanReturnstrueif this was declared to take a variable number of arguments.Explicitly specifies the return type of thisInvokable.Explicitly specifies the return type of thisInvokable.final voidsetAccessible(boolean flag) toString()final booleanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.reflect.AnnotatedElement
getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByTypeMethods inherited from interface java.lang.reflect.Member
accessFlags
-
Method Details
-
from
-
from
ReturnsInvokableofconstructor. -
isAnnotationPresent
- Specified by:
isAnnotationPresentin interfaceAnnotatedElement
-
getAnnotation
- Specified by:
getAnnotationin interfaceAnnotatedElement
-
getAnnotations
- Specified by:
getAnnotationsin interfaceAnnotatedElement
-
getDeclaredAnnotations
- Specified by:
getDeclaredAnnotationsin interfaceAnnotatedElement
-
getTypeParameters
-
setAccessible
-
trySetAccessible
-
isAccessible
-
getName
-
getModifiers
- Specified by:
getModifiersin interfaceMember
-
isSynthetic
- Specified by:
isSyntheticin interfaceMember
-
isPublic
Returns true if the element is public. -
isProtected
Returns true if the element is protected. -
isPackagePrivate
Returns true if the element is package-private. -
isPrivate
Returns true if the element is private. -
isStatic
Returns true if the element is static. -
isFinal
Returnstrueif this method is final, perModifier.isFinal(getModifiers()).Note that a method may still be effectively "final", or non-overridable when it has no
finalkeyword. For example, it could be private, or it could be declared by a final class. To tell whether a method is overridable, useisOverridable(). -
isAbstract
Returns true if the method is abstract. -
isNative
Returns true if the element is native. -
isSynchronized
Returns true if the method is synchronized. -
equals
-
hashCode
-
toString
-
isOverridable
Returnstrueif this is an overridable method. Constructors, private, static or final methods, or methods declared by final classes are not overridable. -
isVarArgs
Returnstrueif this was declared to take a variable number of arguments. -
invoke
@CanIgnoreReturnValue public final @Nullable R invoke(@Nullable T receiver, @Nullable Object... args) throws InvocationTargetException, IllegalAccessException Invokes withreceiveras 'this' andargspassed to the underlying method and returns the return value; or calls the underlying constructor withargsand returns the constructed instance.- Throws:
IllegalAccessException- if thisConstructorobject enforces Java language access control and the underlying method or constructor is inaccessible.IllegalArgumentException- if the number of actual and formal parameters differ; if an unwrapping conversion for primitive arguments fails; or if, after possible unwrapping, a parameter value cannot be converted to the corresponding formal parameter type by a method invocation conversion.InvocationTargetException- if the underlying method or constructor throws an exception.
-
getReturnType
Returns the return type of thisInvokable. -
getParameters
Returns all declared parameters of thisInvokable. Note that if this is a constructor of a non-static inner class, unlikeConstructor.getParameterTypes(), the hiddenthisparameter of the enclosing class is excluded from the returned parameters. -
getExceptionTypes
Returns all declared exception types of thisInvokable. -
returning
-
returning
-
getDeclaringClass
- Specified by:
getDeclaringClassin interfaceMember
-
getOwnerType
Returns the type ofT.
-