io.github.classgraph

Class AnnotationInfoList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

io.github.classgraph.InfoList<T>

io.github.classgraph.MappableInfoList<AnnotationInfo>

io.github.classgraph.AnnotationInfoList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<AnnotationInfo>, Collection<AnnotationInfo>, List<AnnotationInfo>, RandomAccess

public class AnnotationInfoList
extends MappableInfoList<AnnotationInfo>

A list of AnnotationInfo objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AnnotationInfoList.AnnotationInfoFilter Filter an AnnotationInfoList using a predicate mapping an AnnotationInfo object to a boolean, producing another AnnotationInfoList for all items in the list for which the predicate is true.

Constructor Summary

Constructors

Constructor and Description
AnnotationInfoList() Construct a new modifiable empty list of AnnotationInfo objects.
AnnotationInfoList(AnnotationInfoList reachableAnnotations) Construct a new modifiable empty AnnotationInfoList, given an initial list of AnnotationInfo objects.
AnnotationInfoList(int sizeHint) Construct a new modifiable empty list of AnnotationInfo objects, given a size hint.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T element)
boolean	addAll(Collection<? extends T> c)
boolean	addAll(int index, Collection<? extends T> c)
void	clear()
AnnotationInfoList	directOnly() returns the list of direct annotations, excluding meta-annotations.
static AnnotationInfoList	emptyList() Return an unmodifiable empty AnnotationInfoList.
boolean	equals(Object obj)
AnnotationInfoList	filter(AnnotationInfoList.AnnotationInfoFilter filter) Find the subset of the AnnotationInfo objects in this list for which the given filter predicate is true.
AnnotationInfoList	getRepeatable(Class<? extends Annotation> annotationClass) Get the Repeatable annotation with the given class, or the empty list if none found.
AnnotationInfoList	getRepeatable(String name) Get the Repeatable annotation with the given name, or the empty list if none found.
int	hashCode()
Iterator<T>	iterator()
ListIterator<T>	listIterator()
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)

Methods inherited from class io.github.classgraph.MappableInfoList

asMap, containsName, get

Methods inherited from class io.github.classgraph.InfoList

getAsStrings, getAsStringsWithSimpleNames, getNames

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, lastIndexOf, listIterator, removeIf, replaceAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

AnnotationInfoList

public AnnotationInfoList()

Construct a new modifiable empty list of AnnotationInfo objects.

AnnotationInfoList

public AnnotationInfoList(int sizeHint)

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

Parameters:

sizeHint - the size hint

AnnotationInfoList

public AnnotationInfoList(AnnotationInfoList reachableAnnotations)

Construct a new modifiable empty AnnotationInfoList, given an initial list of AnnotationInfo objects.

Parameters:

reachableAnnotations - the reachable annotations

Method Detail

emptyList

public static AnnotationInfoList emptyList()

Return an unmodifiable empty AnnotationInfoList.

Returns:

the unmodifiable empty AnnotationInfoList.

filter

public AnnotationInfoList filter(AnnotationInfoList.AnnotationInfoFilter filter)

Find the subset of the AnnotationInfo objects in this list for which the given filter predicate is true.

Parameters:

filter - The AnnotationInfoList.AnnotationInfoFilter to apply.

Returns:

The subset of the AnnotationInfo objects in this list for which the given filter predicate is true.

directOnly

public AnnotationInfoList directOnly()

returns the list of direct annotations, excluding meta-annotations. If this AnnotationInfoList consists of class annotations, i.e. if it was produced using `ClassInfo#getAnnotationInfo()`, then the returned list also excludes annotations inherited from a superclass or implemented interface that was meta-annotated with @Inherited.

Returns:

The list of directly-related annotations.

getRepeatable

public AnnotationInfoList getRepeatable(Class<? extends Annotation> annotationClass)

Get the Repeatable annotation with the given class, or the empty list if none found.

Parameters:

annotationClass - The class to search for.

Returns:

The list of annotations with the given class, or the empty list if none found.

getRepeatable

public AnnotationInfoList getRepeatable(String name)

Get the Repeatable annotation with the given name, or the empty list if none found.

Parameters:

name - The name to search for.

Returns:

The list of annotations with the given name, or the empty list if none found.

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<AnnotationInfo>

Specified by:

equals in interface List<AnnotationInfo>

Overrides:

equals in class InfoList<AnnotationInfo>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<AnnotationInfo>

Specified by:

hashCode in interface List<AnnotationInfo>

Overrides:

hashCode in class InfoList<AnnotationInfo>

add

public boolean add(T element)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Overrides:

add in class ArrayList<T>

add

public void add(int index,
                T element)

Specified by:

add in interface List<T>

Overrides:

add in class ArrayList<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Overrides:

remove in class ArrayList<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

Overrides:

remove in class ArrayList<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

Overrides:

addAll in class ArrayList<T>

addAll

public boolean addAll(int index,
                      Collection<? extends T> c)

Specified by:

addAll in interface List<T>

Overrides:

addAll in class ArrayList<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

Overrides:

removeAll in class ArrayList<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

Overrides:

retainAll in class ArrayList<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

Overrides:

clear in class ArrayList<T>

set

public T set(int index,
             T element)

Specified by:

set in interface List<T>

Overrides:

set in class ArrayList<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface List<T>

Overrides:

iterator in class ArrayList<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

Overrides:

listIterator in class ArrayList<T>