Package com.google.common.reflect
Class Invokable<T,R>
java.lang.Object
java.lang.reflect.AccessibleObject
com.google.common.reflect.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
,GenericDeclaration
,Member
Wrapper around either a
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());
- Since:
- 14.0
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static <T> Invokable
<T, T> from
(Constructor<T> constructor) ReturnsInvokable
ofconstructor
.ReturnsInvokable
ofmethod
.final <A extends Annotation>
AgetAnnotation
(Class<A> annotationClass) final Annotation[]
final Annotation[]
final ImmutableList
<TypeToken<? extends Throwable>> Returns all declared exception types of thisInvokable
.final int
final String
getName()
Returns the type ofT
.final ImmutableList
<Parameter> Returns all declared parameters of thisInvokable
.Returns the return type of thisInvokable
.int
hashCode()
final R
Invokes withreceiver
as 'this' andargs
passed to the underlying method and returns the return value; or calls the underlying constructor withargs
and returns the constructed instance.final boolean
Returns true if the method is abstract.final boolean
final boolean
isAnnotationPresent
(Class<? extends Annotation> annotationClass) final boolean
isFinal()
Returnstrue
if this method is final, perModifier.isFinal(getModifiers())
.final boolean
isNative()
Returns true if the element is native.abstract boolean
Returnstrue
if this is an overridable method.final boolean
Returns true if the element is package-private.final boolean
Returns true if the element is private.final boolean
Returns true if the element is protected.final boolean
isPublic()
Returns true if the element is public.final boolean
isStatic()
Returns true if the element is static.final boolean
Returns true if the method is synchronized.final boolean
abstract boolean
Returnstrue
if 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 void
setAccessible
(boolean flag) toString()
Methods inherited from class java.lang.reflect.AccessibleObject
canAccess, getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType, setAccessible, trySetAccessible
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.reflect.AnnotatedElement
getAnnotation, getAnnotations, getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotations, getDeclaredAnnotationsByType, isAnnotationPresent
Methods inherited from interface java.lang.reflect.GenericDeclaration
getTypeParameters
Methods inherited from interface java.lang.reflect.Member
accessFlags
-
Method Details
-
from
ReturnsInvokable
ofmethod
. -
from
ReturnsInvokable
ofconstructor
. -
isOverridable
public abstract boolean isOverridable()Returnstrue
if this is an overridable method. Constructors, private, static or final methods, or methods declared by final classes are not overridable. -
isVarArgs
public abstract boolean isVarArgs()Returnstrue
if this was declared to take a variable number of arguments. -
invoke
public final R invoke(@Nullable T receiver, Object... args) throws InvocationTargetException, IllegalAccessException Invokes withreceiver
as 'this' andargs
passed to the underlying method and returns the return value; or calls the underlying constructor withargs
and returns the constructed instance.- Throws:
IllegalAccessException
- if thisConstructor
object 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 hiddenthis
parameter of the enclosing class is excluded from the returned parameters. -
getExceptionTypes
Returns all declared exception types of thisInvokable
. -
returning
Explicitly specifies the return type of thisInvokable
. For example:Method factoryMethod = Person.class.getMethod("create"); Invokable<?, Person> factory = Invokable.of(getNameMethod).returning(Person.class);
-
returning
Explicitly specifies the return type of thisInvokable
. -
getDeclaringClass
- Specified by:
getDeclaringClass
in interfaceMember
-
getOwnerType
Returns the type ofT
. -
isAnnotationPresent
- Specified by:
isAnnotationPresent
in interfaceAnnotatedElement
- Overrides:
isAnnotationPresent
in classAccessibleObject
-
getAnnotation
- Specified by:
getAnnotation
in interfaceAnnotatedElement
- Overrides:
getAnnotation
in classAccessibleObject
-
getAnnotations
- Specified by:
getAnnotations
in interfaceAnnotatedElement
- Overrides:
getAnnotations
in classAccessibleObject
-
getDeclaredAnnotations
- Specified by:
getDeclaredAnnotations
in interfaceAnnotatedElement
- Overrides:
getDeclaredAnnotations
in classAccessibleObject
-
setAccessible
- Overrides:
setAccessible
in classAccessibleObject
- Throws:
SecurityException
-
isAccessible
public final boolean isAccessible()- Overrides:
isAccessible
in classAccessibleObject
-
getName
-
getModifiers
public final int getModifiers()- Specified by:
getModifiers
in interfaceMember
-
isSynthetic
public final boolean isSynthetic()- Specified by:
isSynthetic
in interfaceMember
-
isPublic
public final boolean isPublic()Returns true if the element is public. -
isProtected
public final boolean isProtected()Returns true if the element is protected. -
isPackagePrivate
public final boolean isPackagePrivate()Returns true if the element is package-private. -
isPrivate
public final boolean isPrivate()Returns true if the element is private. -
isStatic
public final boolean isStatic()Returns true if the element is static. -
isFinal
public final boolean isFinal()Returnstrue
if this method is final, perModifier.isFinal(getModifiers())
.Note that a method may still be effectively "final", or non-overridable when it has no
final
keyword. For example, it could be private, or it could be declared by a final class. To tell whether a method is overridable, useisOverridable()
. -
isAbstract
public final boolean isAbstract()Returns true if the method is abstract. -
isNative
public final boolean isNative()Returns true if the element is native. -
isSynchronized
public final boolean isSynchronized()Returns true if the method is synchronized. -
equals
-
hashCode
public int hashCode() -
toString
-