ClassGraph 4.8.179 · io.github.classgraph.MethodParameterInfo

Modifier and Type	Field and Description
pack-priv final AnnotationInfo[]	annotationInfo The annotation info.
private final MethodInfo	methodInfo The containing method.
private final int	modifiers The modifiers.
private final String	name The parameter name.
private ScanResult	scanResult The scan result.
private final TypeSignature	typeDescriptor The type descriptor.
private final TypeSignature	typeSignature The type signature.

Access	Constructor and Description
pack-priv	MethodParameterInfo(final MethodInfo The `MethodInfo` for the defining method. methodInfo, final AnnotationInfo[] `AnnotationInfo` for any annotations on this method parameter. annotationInfo, final int The method parameter modifiers. modifiers, final TypeSignature The method parameter type descriptor. typeDescriptor, final TypeSignature The method parameter type signature. typeSignature, final String The method parameter name. name) Constructor.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public AnnotationInfoList	Returns: `AnnotationInfo` for any annotations on this method parameter. getAnnotationInfo() Method parameter annotation info (or null if no annotations).
public AnnotationInfo	Returns: An `AnnotationInfo` object representing the annotation on this method parameter, or null if the method parameter does not have the annotation. getAnnotationInfo(final Class<? extends Annotation> The annotation. annotation) Get a the non-`Repeatable` annotation on this method, or null if the method parameter does not have the annotation.
public AnnotationInfo	Returns: An `AnnotationInfo` object representing the named annotation on this method parameter, or null if the method parameter does not have the named annotation. getAnnotationInfo(final String The annotation name. annotationName) Get a the named non-`Repeatable` annotation on this method, or null if the method parameter does not have the named annotation.
public AnnotationInfoList	Returns: An `AnnotationInfoList` containing all instances of the annotation on this method parameter, or the empty list if the method parameter does not have the annotation. getAnnotationInfoRepeatable(final Class<? extends Annotation> The annotation. annotation) Get a the `Repeatable` annotation on this method, or the empty list if the method parameter does not have the annotation.
public AnnotationInfoList	Returns: An `AnnotationInfoList` containing all instances of the named annotation on this method parameter, or the empty list if the method parameter does not have the named annotation. getAnnotationInfoRepeatable(final String The annotation name. annotationName) Get a the named `Repeatable` annotation on this method, or the empty list if the method parameter does not have the named annotation.
public MethodInfo	Returns: The `MethodInfo` for the defining method. getMethodInfo() Get the `MethodInfo` for the defining method.
public int	Returns: The method parameter modifiers. getModifiers() Method parameter modifiers.
public String	Returns: The modifiers for the method parameter, as a String. getModifiersStr() Get the method parameter modifiers as a String, e.g. "final".
public String	Returns: The method parameter name. getName() Method parameter name.
public TypeSignature	Returns: The method type descriptor. getTypeDescriptor() Method parameter type descriptor.
public TypeSignature	Returns: The method type signature, if available, else null. getTypeSignature() Method parameter type signature, possibly including generic type information (or null if no type signature information available for this parameter).
public TypeSignature	Returns: The method type signature, if present, otherwise the method type descriptor. getTypeSignatureOrTypeDescriptor() Method parameter type signature, or if not available, method type descriptor.
public boolean	Returns: true if this method parameter has the annotation. hasAnnotation(final Class<? extends Annotation> The annotation. annotation) Check whether this method parameter has the annotation.
public boolean	Returns: true if this method parameter has the named annotation. hasAnnotation(final String The name of an annotation. annotationName) Check whether this method parameter has the named annotation.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: True if this method parameter is final. isFinal() Returns true if this method parameter is final.
public boolean	Returns: True if this method parameter is mandated. isMandated() Returns true if this method parameter is mandated.
public boolean	Returns: True if this method parameter is synthetic. isSynthetic() Returns true if this method parameter is synthetic.
pack-priv static void	modifiersToString(final int The field or method modifiers. modifiers, final StringBuilder The buffer to write the result into. buf) Convert modifiers into a string representation, e.g. "public static final".
protected void	setScanResult(final ScanResult the new scan result scanResult) Sets the scan result.
protected void	toString(final boolean if true, use just the simple name of each class. useSimpleNames, final StringBuilder the buf buf) Render to string.
public String	Returns: the string representation. toString() Overrides java.lang.Object.toString. Render to string.
public String	Returns: the string representation. toStringWithSimpleNames() Render to string with simple names for classes.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

annotationInfo	back to summary
pack-priv final AnnotationInfo[] annotationInfo The annotation info.

methodInfo	back to summary
private final MethodInfo methodInfo The containing method.

modifiers	back to summary
private final int modifiers The modifiers.

name	back to summary
private final String name The parameter name.

scanResult	back to summary
private ScanResult scanResult The scan result.

typeDescriptor	back to summary
private final TypeSignature typeDescriptor The type descriptor.

typeSignature	back to summary
private final TypeSignature typeSignature The type signature.

MethodParameterInfo	back to summary
pack-priv MethodParameterInfo(final MethodInfo methodInfo, final AnnotationInfo[] annotationInfo, final int modifiers, final TypeSignature typeDescriptor, final TypeSignature typeSignature, final String name) Constructor. Parameters methodInfo:MethodInfo The `MethodInfo` for the defining method. annotationInfo:AnnotationInfo[] `AnnotationInfo` for any annotations on this method parameter. modifiers:int The method parameter modifiers. typeDescriptor:TypeSignature The method parameter type descriptor. typeSignature:TypeSignature The method parameter type signature. name:String The method parameter name.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAnnotationInfo back to summary

getAnnotationInfo	back to summary
public AnnotationInfoList getAnnotationInfo() Method parameter annotation info (or null if no annotations). Returns:AnnotationInfoList `AnnotationInfo` for any annotations on this method parameter.

public AnnotationInfoList getAnnotationInfo()

Method parameter annotation info (or null if no annotations).

Returns:AnnotationInfoList: AnnotationInfo for any annotations on this method parameter.

getAnnotationInfo back to summary

getAnnotationInfo	back to summary
public AnnotationInfo getAnnotationInfo(final Class<? extends Annotation> annotation) Get a the non-`Repeatable` annotation on this method, or null if the method parameter does not have the annotation. (Use `getAnnotationInfoRepeatable(Class)` for `Repeatable` annotations.) Parameters annotation:Class<? extends Annotation> The annotation. Returns:AnnotationInfo An `AnnotationInfo` object representing the annotation on this method parameter, or null if the method parameter does not have the annotation.

public AnnotationInfo getAnnotationInfo(final Class<? extends Annotation> annotation)

Get a the non-Repeatable annotation on this method, or null if the method parameter does not have the annotation. (Use getAnnotationInfoRepeatable(Class) for Repeatable annotations.)

Parameters

annotation:Class<? extends Annotation>: The annotation.

Returns:AnnotationInfo

An AnnotationInfo object representing the annotation on this method parameter, or null if the method parameter does not have the annotation.

getAnnotationInfo back to summary

getAnnotationInfo	back to summary
public AnnotationInfo getAnnotationInfo(final String annotationName) Get a the named non-`Repeatable` annotation on this method, or null if the method parameter does not have the named annotation. (Use `getAnnotationInfoRepeatable(String)` for `Repeatable` annotations.) Parameters annotationName:String The annotation name. Returns:AnnotationInfo An `AnnotationInfo` object representing the named annotation on this method parameter, or null if the method parameter does not have the named annotation.

public AnnotationInfo getAnnotationInfo(final String annotationName)

Get a the named non-Repeatable annotation on this method, or null if the method parameter does not have the named annotation. (Use getAnnotationInfoRepeatable(String) for Repeatable annotations.)

Parameters

annotationName:String: The annotation name.

Returns:AnnotationInfo

An AnnotationInfo object representing the named annotation on this method parameter, or null if the method parameter does not have the named annotation.

getAnnotationInfoRepeatable back to summary

getAnnotationInfoRepeatable	back to summary
public AnnotationInfoList getAnnotationInfoRepeatable(final Class<? extends Annotation> annotation) Get a the `Repeatable` annotation on this method, or the empty list if the method parameter does not have the annotation. Parameters annotation:Class<? extends Annotation> The annotation. Returns:AnnotationInfoList An `AnnotationInfoList` containing all instances of the annotation on this method parameter, or the empty list if the method parameter does not have the annotation.

public AnnotationInfoList getAnnotationInfoRepeatable(final Class<? extends Annotation> annotation)

Get a the Repeatable annotation on this method, or the empty list if the method parameter does not have the annotation.

Parameters

annotation:Class<? extends Annotation>: The annotation.

Returns:AnnotationInfoList

An AnnotationInfoList containing all instances of the annotation on this method parameter, or the empty list if the method parameter does not have the annotation.

getAnnotationInfoRepeatable back to summary

getAnnotationInfoRepeatable	back to summary
public AnnotationInfoList getAnnotationInfoRepeatable(final String annotationName) Get a the named `Repeatable` annotation on this method, or the empty list if the method parameter does not have the named annotation. Parameters annotationName:String The annotation name. Returns:AnnotationInfoList An `AnnotationInfoList` containing all instances of the named annotation on this method parameter, or the empty list if the method parameter does not have the named annotation.

public AnnotationInfoList getAnnotationInfoRepeatable(final String annotationName)

Get a the named Repeatable annotation on this method, or the empty list if the method parameter does not have the named annotation.

Parameters

annotationName:String: The annotation name.

Returns:AnnotationInfoList

An AnnotationInfoList containing all instances of the named annotation on this method parameter, or the empty list if the method parameter does not have the named annotation.

getMethodInfo back to summary

getMethodInfo	back to summary
public MethodInfo getMethodInfo() Get the `MethodInfo` for the defining method. Returns:MethodInfo The `MethodInfo` for the defining method.

public MethodInfo getMethodInfo()

Get the MethodInfo for the defining method.

Returns:MethodInfo: The MethodInfo for the defining method.

getModifiers	back to summary
public int getModifiers() Method parameter modifiers. May be zero, if no modifier bits set, or if compiled for JDK version lower than 8, or if compiled for JDK version 8+ but without the commandline switch `-parameters`. Returns:int The method parameter modifiers.

getModifiers

public Class MethodParameterInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail