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:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MethodInfo>, java.util.Collection<MethodInfo>, java.util.List<MethodInfo>, java.util.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.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
MethodInfoList() Construct a new modifiable empty list of MethodInfo objects.
MethodInfoList(java.util.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(java.util.Collection<? extends T> c)
boolean	addAll(int index, java.util.Collection<? extends T> c)
java.util.Map<java.lang.String,MethodInfoList>	asMap() Get this MethodInfoList as a map from method name to a MethodInfoList of methods with that name.
void	clear()
boolean	containsName(java.lang.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.
protected void	findReferencedClassInfo(java.util.Map<java.lang.String,ClassInfo> classNameToClassInfo, java.util.Set<ClassInfo> refdClassInfo, LogNode log) Get ClassInfo objects for any classes referenced in the type descriptor or type signature.
MethodInfoList	get(java.lang.String methodName) Returns a list of all methods matching a given name.
MethodInfo	getSingleMethod(java.lang.String methodName) Returns a single method with the given name, or null if not found.
java.util.Iterator<T>	iterator()
java.util.ListIterator<T>	listIterator()
T	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.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, 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.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(java.util.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.

findReferencedClassInfo

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

Get ClassInfo objects for any classes referenced in the type descriptor or type signature.

Parameters:

classNameToClassInfo - the map from class name to ClassInfo.

refdClassInfo - the referenced class info

log - the log

asMap

public java.util.Map<java.lang.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(java.lang.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(java.lang.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(java.lang.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:

java.lang.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 java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

add

public void add(int index,
                T element)

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class java.util.ArrayList<T>

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class java.util.ArrayList<T>

addAll

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

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>

addAll

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

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

Overrides:

removeAll in class java.util.ArrayList<T>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

Overrides:

retainAll in class java.util.ArrayList<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<T>

Overrides:

clear in class java.util.ArrayList<T>

set

public T set(int index,
             T element)

Specified by:

set in interface java.util.List<T>

Overrides:

set in class java.util.ArrayList<T>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.List<T>

Overrides:

iterator in class java.util.ArrayList<T>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface java.util.List<T>

Overrides:

listIterator in class java.util.ArrayList<T>