Package io.github.classgraph

Class AnnotationParameterValueList

java.lang.Object

java.util.AbstractCollection<AnnotationParameterValue>

java.util.AbstractList<AnnotationParameterValue>

java.util.ArrayList<AnnotationParameterValue>

io.github.classgraph.PotentiallyUnmodifiableList<AnnotationParameterValue>

io.github.classgraph.InfoList<AnnotationParameterValue>

io.github.classgraph.MappableInfoList<AnnotationParameterValue>

io.github.classgraph.AnnotationParameterValueList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AnnotationParameterValue>, Collection<AnnotationParameterValue>, List<AnnotationParameterValue>, RandomAccess, SequencedCollection<AnnotationParameterValue>

public class AnnotationParameterValueList
extends MappableInfoList<AnnotationParameterValue>

A list of AnnotationParameterValue objects.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final AnnotationParameterValueList	EMPTY_LIST	An unmodifiable empty AnnotationParameterValueList.
private static final long	serialVersionUID	serialVersionUID

Fields inherited from class io.github.classgraph.PotentiallyUnmodifiableList

modifiable

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AnnotationParameterValueList()	Construct a new modifiable empty list of AnnotationParameterValue objects.
AnnotationParameterValueList(int sizeHint)	Construct a new modifiable empty list of AnnotationParameterValue objects, given a size hint.
AnnotationParameterValueList(Collection<AnnotationParameterValue> annotationParameterValueCollection)	Construct a new modifiable empty AnnotationParameterValueList, given an initial list of AnnotationParameterValue objects.

Method Summary

Modifier and Type	Method	Description
(package private) void	convertWrapperArraysToPrimitiveArrays(ClassInfo annotationClassInfo)	For primitive array type params, replace Object[] arrays containing boxed types with primitive arrays (need to check the type of each method of the annotation class to determine if it is a primitive array type).
static AnnotationParameterValueList	emptyList()	Return an unmodifiable empty AnnotationParameterValueList.
protected void	findReferencedClassInfo(Map<String,ClassInfo> classNameToClassInfo, Set<ClassInfo> refdClassInfo, LogNode log)	Get ClassInfo objects for any classes referenced in the methods in this list.
Object	getValue(String parameterName)	Get the annotation parameter value, by calling AnnotationParameterValue.getValue() on the result of MappableInfoList.get(String), if non-null.

Methods inherited from class io.github.classgraph.MappableInfoList

asMap, containsName, get

Methods inherited from class io.github.classgraph.InfoList

equals, getAsStrings, getAsStringsWithSimpleNames, getNames, hashCode

Methods inherited from class io.github.classgraph.PotentiallyUnmodifiableList

add, add, addAll, addAll, clear, iterator, listIterator, makeUnmodifiable, remove, remove, removeAll, retainAll, set

Methods inherited from class java.util.ArrayList

addFirst, addLast, clone, contains, ensureCapacity, forEach, get, getFirst, getLast, indexOf, isEmpty, lastIndexOf, listIterator, removeFirst, removeIf, removeLast, removeRange, replaceAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Field Details

serialVersionUID

private static final long serialVersionUID

serialVersionUID

See Also:

• Constant Field Values

EMPTY_LIST

static final AnnotationParameterValueList EMPTY_LIST

An unmodifiable empty AnnotationParameterValueList.

Constructor Details

AnnotationParameterValueList

public AnnotationParameterValueList()

Construct a new modifiable empty list of AnnotationParameterValue objects.

AnnotationParameterValueList

public AnnotationParameterValueList(int sizeHint)

Construct a new modifiable empty list of AnnotationParameterValue objects, given a size hint.

Parameters:

sizeHint - the size hint

AnnotationParameterValueList

public AnnotationParameterValueList(Collection<AnnotationParameterValue> annotationParameterValueCollection)

Construct a new modifiable empty AnnotationParameterValueList, given an initial list of AnnotationParameterValue objects.

Parameters:

annotationParameterValueCollection - the collection of AnnotationParameterValue objects.

Method Details

emptyList

public static AnnotationParameterValueList emptyList()

Return an unmodifiable empty AnnotationParameterValueList.

Returns:

the unmodifiable empty AnnotationParameterValueList.

findReferencedClassInfo

protected void findReferencedClassInfo(Map<String,ClassInfo> classNameToClassInfo,
 Set<ClassInfo> refdClassInfo,
 LogNode log)

Get ClassInfo objects for any classes referenced in the methods in this list.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

convertWrapperArraysToPrimitiveArrays

void convertWrapperArraysToPrimitiveArrays(ClassInfo annotationClassInfo)

For primitive array type params, replace Object[] arrays containing boxed types with primitive arrays (need to check the type of each method of the annotation class to determine if it is a primitive array type).

Parameters:

annotationClassInfo - the annotation class info

getValue

public Object getValue(String parameterName)

Get the annotation parameter value, by calling AnnotationParameterValue.getValue() on the result of MappableInfoList.get(String), if non-null.

Parameters:

parameterName - The name of an annotation parameter.

Returns:

The value of the AnnotationParameterValue object in the list with the given name, by calling AnnotationParameterValue.getValue() on that object, or null if not found.

The annotation parameter value may be one of the following types:

• String for string constants
• String[] for arrays of strings
• A boxed type, e.g. Integer or Character, for primitive-typed constants
• A 1-dimensional primitive-typed array (i.e. int[], long[], short[], char[], byte[], boolean[], float[], or double[]), for arrays of primitives
• A 1-dimensional Object[] array for array types (and then the array element type may be one of the types in this list)
• AnnotationEnumValue, for enum constants (this wraps the enum class and the string name of the constant)
• AnnotationClassRef, for Class references within annotations (this wraps the name of the referenced class)
• AnnotationInfo, for nested annotations