Class Parameter
- java.lang.Object
-
- com.google.common.reflect.Parameter
-
- All Implemented Interfaces:
AnnotatedElement
@Beta public final class Parameter extends Object implements AnnotatedElement
Represents a method or constructor parameter.- Since:
- 14.0
- Author:
- Ben Yu
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Indicates whether some other object is "equal to" this one.<A extends Annotation>
AgetAnnotation(Class<A> annotationType)Returns this element's annotation for the specified type if such an annotation is present, else null.Annotation[]getAnnotations()Returns annotations that are present on this element.<A extends Annotation>
A[]getAnnotationsByType(Class<A> annotationType)Returns annotations that are associated with this element.<A extends Annotation>
AgetDeclaredAnnotation(Class<A> annotationType)Returns this element's annotation for the specified type if such an annotation is directly present, else null.Annotation[]getDeclaredAnnotations()Returns annotations that are directly present on this element.<A extends Annotation>
A[]getDeclaredAnnotationsByType(Class<A> annotationType)Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present.Invokable<?,?>getDeclaringInvokable()Returns theInvokablethat declares this parameter.TypeToken<?>getType()Returns the type of the parameter.inthashCode()Returns a hash code value for the object.booleanisAnnotationPresent(Class<? extends Annotation> annotationType)Returns true if an annotation for the specified type is present on this element, else false.StringtoString()Returns a string representation of the object.
-
-
-
Method Detail
-
getDeclaringInvokable
public Invokable<?,?> getDeclaringInvokable()
Returns theInvokablethat declares this parameter.
-
isAnnotationPresent
public boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
Description copied from interface:java.lang.reflect.AnnotatedElementReturns true if an annotation for the specified type is present on this element, else false. This method is designed primarily for convenient access to marker annotations.The truth value returned by this method is equivalent to:
getAnnotation(annotationClass) != nullThe body of the default method is specified to be the code above.
- Specified by:
isAnnotationPresentin interfaceAnnotatedElement- Parameters:
annotationType- the Class object corresponding to the annotation type- Returns:
- true if an annotation for the specified annotation type is present on this element, else false
-
getAnnotation
@NullableDecl public <A extends Annotation> A getAnnotation(Class<A> annotationType)
Description copied from interface:java.lang.reflect.AnnotatedElementReturns this element's annotation for the specified type if such an annotation is present, else null.- Specified by:
getAnnotationin interfaceAnnotatedElement- Type Parameters:
A- the type of the annotation to query for and return if present- Parameters:
annotationType- the Class object corresponding to the annotation type- Returns:
- this element's annotation for the specified annotation type if present on this element, else null
-
getAnnotations
public Annotation[] getAnnotations()
Description copied from interface:java.lang.reflect.AnnotatedElementReturns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Specified by:
getAnnotationsin interfaceAnnotatedElement- Returns:
- annotations present on this element
-
getAnnotationsByType
public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)
Description copied from interface:java.lang.reflect.AnnotatedElementReturns annotations that are associated with this element. If there are no annotations associated with this element, the return value is an array of length 0. The difference between this method andAnnotatedElement.getAnnotation(Class)is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Specified by:
getAnnotationsByTypein interfaceAnnotatedElement- Type Parameters:
A- the type of the annotation to query for and return if present- Parameters:
annotationType- the Class object corresponding to the annotation type- Returns:
- all this element's annotations for the specified annotation type if associated with this element, else an array of length zero
- Since:
- 18.0
-
getDeclaredAnnotations
public Annotation[] getDeclaredAnnotations()
Description copied from interface:java.lang.reflect.AnnotatedElementReturns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Specified by:
getDeclaredAnnotationsin interfaceAnnotatedElement- Returns:
- annotations directly present on this element
- Since:
- 18.0
-
getDeclaredAnnotation
@NullableDecl public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationType)
Description copied from interface:java.lang.reflect.AnnotatedElementReturns this element's annotation for the specified type if such an annotation is directly present, else null. This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)- Specified by:
getDeclaredAnnotationin interfaceAnnotatedElement- Type Parameters:
A- the type of the annotation to query for and return if directly present- Parameters:
annotationType- the Class object corresponding to the annotation type- Returns:
- this element's annotation for the specified annotation type if directly present on this element, else null
- Since:
- 18.0
-
getDeclaredAnnotationsByType
public <A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationType)
Description copied from interface:java.lang.reflect.AnnotatedElementReturns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present. This method ignores inherited annotations. If there are no specified annotations directly or indirectly present on this element, the return value is an array of length 0. The difference between this method andAnnotatedElement.getDeclaredAnnotation(Class)is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation if one is present. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.- Specified by:
getDeclaredAnnotationsByTypein interfaceAnnotatedElement- Type Parameters:
A- the type of the annotation to query for and return if directly or indirectly present- Parameters:
annotationType- the Class object corresponding to the annotation type- Returns:
- all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero
- Since:
- 18.0
-
equals
public boolean equals(@NullableDecl Object obj)
Description copied from class:java.lang.ObjectIndicates whether some other object is "equal to" this one.The
equalsmethod implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The
equalsmethod for classObjectimplements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesxandy, this method returnstrueif and only ifxandyrefer to the same object (x == yhas the valuetrue).Note that it is generally necessary to override the
hashCodemethod whenever this method is overridden, so as to maintain the general contract for thehashCodemethod, which states that equal objects must have equal hash codes.- Overrides:
equalsin classObject- Parameters:
obj- the reference object with which to compare.- Returns:
trueif this object is the same as the obj argument;falseotherwise.- See Also:
Object.hashCode(),HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public int hashCode()
Description copied from class:java.lang.ObjectReturns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap.The general contract of
hashCodeis:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)method, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Objectdoes return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Overrides:
hashCodein classObject- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public String toString()
Description copied from class:java.lang.ObjectReturns a string representation of the object. In general, thetoStringmethod returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.The
toStringmethod for classObjectreturns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:getClass().getName() + '@' + Integer.toHexString(hashCode())
-
-