Package io.github.classgraph

Class ResourceList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<Resource>

io.github.classgraph.ResourceList

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable, java.lang.Cloneable, java.lang.Iterable<Resource>, java.util.Collection<Resource>, java.util.List<Resource>, java.util.RandomAccess

public class ResourceList
extends java.util.ArrayList<Resource>
implements java.lang.AutoCloseable

An AutoCloseable list of AutoCloseable Resource objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceList.ByteArrayConsumer	A FunctionalInterface for consuming the contents of a Resource as a byte array.
static interface	ResourceList.ByteBufferConsumer	A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer.
static interface	ResourceList.InputStreamConsumer	A FunctionalInterface for consuming the contents of a Resource as an InputStream.
static interface	ResourceList.ResourceFilter	Filter a ResourceList using a predicate mapping a Resource object to a boolean, producing another ResourceList for all items in the list for which the predicate is true.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,ResourceList>	asMap()
ResourceList	classFilesOnly()
void	close()	Close all the Resource objects in this ResourceList.
ResourceList	filter(ResourceList.ResourceFilter filter)	Find the subset of the Resource objects in this list for which the given filter predicate is true.
java.util.List<java.util.Map.Entry<java.lang.String,ResourceList>>	findDuplicatePaths()
void	forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer)	Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().
void	forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer, boolean ignoreIOExceptions)	Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().
void	forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer)	Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().
void	forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer, boolean ignoreIOExceptions)	Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().
void	forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer)	Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().
void	forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer, boolean ignoreIOExceptions)	Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().
java.util.List<java.lang.String>	getPaths()
java.util.List<java.lang.String>	getPathsRelativeToClasspathElement()
java.util.List<java.net.URL>	getURLs()
ResourceList	nonClassFilesOnly()
java.lang.String	toString()

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

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

Method Detail

getPaths

public java.util.List<java.lang.String> getPaths()

Returns:

The paths of all resources in this list relative to the package root of the classpath element, by calling Resource.getPath() for each item in the list. For example, given a resource path of "BOOT-INF/classes/com/xyz/resource.xml" and a package root of "BOOT-INF/classes/", returns "com/xyz/resource.xml".

getPathsRelativeToClasspathElement

public java.util.List<java.lang.String> getPathsRelativeToClasspathElement()

Returns:

The paths of all resources in this list relative to the root of the classpath element, by calling Resource.getPathRelativeToClasspathElement() for each item in the list. For example, given a resource path of "BOOT-INF/classes/com/xyz/resource.xml", returns "BOOT-INF/classes/com/xyz/resource.xml" (even if the package root is "BOOT-INF/classes/").

getURLs

public java.util.List<java.net.URL> getURLs()

Returns:

The URLs of all resources in this list, by calling Resource.getURL() for each item in the list.

classFilesOnly

public ResourceList classFilesOnly()

Returns:

A new ResourceList consisting of only the resources with the filename extension ".class".

nonClassFilesOnly

public ResourceList nonClassFilesOnly()

Returns:

A new ResourceList consisting of only the resources that do not have the filename extension ".class".

asMap

public java.util.Map<java.lang.String,ResourceList> asMap()

Returns:

This ResourceList as a map from path (obtained from Resource.getPath()), to a ResourceList of Resource objects that have that path.

findDuplicatePaths

public java.util.List<java.util.Map.Entry<java.lang.String,ResourceList>> findDuplicatePaths()

Returns:

A List of Map.Entry objects for all resources in the classpath and/or module path that have a non-unique path (i.e. where there are at least two resources with the same path). The key of each returned Map.Entry is the path (obtained from Resource.getPath()), and the value is a ResourceList of at least two unique Resource objects that have that path.

filter

public ResourceList filter(ResourceList.ResourceFilter filter)

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

Parameters:

filter - The ResourceList.ResourceFilter to apply.

Returns:

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

forEachByteArray

public void forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer,
                             boolean ignoreIOExceptions)

Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().

Parameters:

byteArrayConsumer - The ResourceList.ByteArrayConsumer.

ignoreIOExceptions - if true, any IOException thrown while trying to load any of the resources will be silently ignored.

Throws:

java.lang.IllegalArgumentException - if ignoreExceptions is false, and an IOException is thrown while trying to load any of the resources.

forEachByteArray

public void forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer)

Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().

Parameters:

byteArrayConsumer - The ResourceList.ByteArrayConsumer.

Throws:

java.lang.IllegalArgumentException - if trying to load any of the resources results in an IOException being thrown.

forEachInputStream

public void forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer,
                               boolean ignoreIOExceptions)

Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().

Parameters:

inputStreamConsumer - The ResourceList.InputStreamConsumer.

ignoreIOExceptions - if true, any IOException thrown while trying to load any of the resources will be silently ignored.

Throws:

java.lang.IllegalArgumentException - if ignoreExceptions is false, and an IOException is thrown while trying to open any of the resources.

forEachInputStream

public void forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer)

Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().

Parameters:

inputStreamConsumer - The ResourceList.InputStreamConsumer.

Throws:

java.lang.IllegalArgumentException - if trying to open any of the resources results in an IOException being thrown.

forEachByteBuffer

public void forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer,
                              boolean ignoreIOExceptions)

Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().

Parameters:

byteBufferConsumer - The ResourceList.ByteBufferConsumer.

ignoreIOExceptions - if true, any IOException thrown while trying to load any of the resources will be silently ignored.

Throws:

java.lang.IllegalArgumentException - if ignoreExceptions is false, and an IOException is thrown while trying to load any of the resources.

forEachByteBuffer

public void forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer)

Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().

Parameters:

byteBufferConsumer - The ResourceList.ByteBufferConsumer.

Throws:

java.lang.IllegalArgumentException - if trying to load any of the resources results in an IOException being thrown.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<Resource>

close

public void close()

Close all the Resource objects in this ResourceList.

Specified by:

close in interface java.lang.AutoCloseable