io.github.classgraph

Class MethodInfoList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

io.github.classgraph.InfoList<MethodInfo>

io.github.classgraph.MethodInfoList

All Implemented Interfaces:

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

public class MethodInfoList
extends InfoList<MethodInfo>

A list of MethodInfo objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
MethodInfoList() Construct a new modifiable empty list of MethodInfo objects.
MethodInfoList(Collection<MethodInfo> methodInfoCollection) Construct a new modifiable empty MethodInfoList, given an initial collection of MethodInfo objects.
MethodInfoList(int sizeHint) Construct a new modifiable empty list of MethodInfo 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)
Map<String,MethodInfoList>	asMap() Get this MethodInfoList as a map from method name to a MethodInfoList of methods with that name.
void	clear()
boolean	containsName(String methodName) Check whether the list contains a method with the given name.
static MethodInfoList	emptyList() Return an unmodifiable empty MethodInfoList.
MethodInfoList	filter(MethodInfoList.MethodInfoFilter filter) Find the subset of the MethodInfo objects in this list for which the given filter predicate is true.
MethodInfoList	get(String methodName) Returns a list of all methods matching a given name.
MethodInfo	getSingleMethod(String methodName) Returns a single method with the given name, or null if not found.
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.InfoList

equals, getAsStrings, getAsStringsWithSimpleNames, getNames, hashCode

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

MethodInfoList

public MethodInfoList()

Construct a new modifiable empty list of MethodInfo objects.

MethodInfoList

public MethodInfoList(int sizeHint)

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

Parameters:

sizeHint - the size hint

MethodInfoList

public MethodInfoList(Collection<MethodInfo> methodInfoCollection)

Construct a new modifiable empty MethodInfoList, given an initial collection of MethodInfo objects.

Parameters:

methodInfoCollection - the collection of MethodInfo objects.

Method Detail

emptyList

public static MethodInfoList emptyList()

Return an unmodifiable empty MethodInfoList.

Returns:

the unmodifiable empty MethodInfoList.

asMap

public Map<String,MethodInfoList> asMap()

Get this MethodInfoList as a map from method name to a MethodInfoList of methods with that name.

Returns:

This MethodInfoList as a map from method name to a MethodInfoList of methods with that name.

containsName

public boolean containsName(String methodName)

Check whether the list contains a method with the given name.

Parameters:

methodName - The name of a class.

Returns:

true if the list contains a method with the given name.

get

public MethodInfoList get(String methodName)

Returns a list of all methods matching a given name. (There may be more than one method with a given name, due to overloading, so this returns a MethodInfoList rather than a single MethodInfo.)

Parameters:

methodName - The name of a method.

Returns:

A MethodInfoList of MethodInfo objects from this list that have the given name (there may be more than one method with a given name, due to overloading, so this returns a MethodInfoList rather than a single MethodInfo). Returns the empty list if no method had a matching name.

getSingleMethod

public MethodInfo getSingleMethod(String methodName)

Returns a single method with the given name, or null if not found. Throws IllegalArgumentException if there are two methods with the given name.

Parameters:

methodName - The name of a method.

Returns:

The MethodInfo object from the list with the given name, if there is exactly one method with the given name. Returns null if there were no methods with the given name.

Throws:

IllegalArgumentException - if there are two or more methods with the given name.

filter

public MethodInfoList filter(MethodInfoList.MethodInfoFilter filter)

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

Parameters:

filter - The MethodInfoList.MethodInfoFilter to apply.

Returns:

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

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>