Package io.github.classgraph

Class ResourceList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

io.github.classgraph.PotentiallyUnmodifiableList<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 PotentiallyUnmodifiableList<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.ByteArrayConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as a byte array, throwing IOException to the caller if an IO exception occurs.
static interface	ResourceList.ByteBufferConsumer	A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer.
static interface	ResourceList.ByteBufferConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer, throwing IOException to the caller if an IO exception occurs.
static interface	ResourceList.InputStreamConsumer	A FunctionalInterface for consuming the contents of a Resource as an InputStream.
static interface	ResourceList.InputStreamConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as an InputStream, throwing IOException to the caller if an IO exception occurs.
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

Modifier and Type	Field	Description
private static ResourceList.ResourceFilter	CLASSFILE_FILTER	Returns true if a Resource has a path ending in ".class".
(package private) static ResourceList	EMPTY_LIST	An unmodifiable empty ResourceList.
(package private) static 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
ResourceList()	Create a new modifiable empty list of Resource objects.
ResourceList(int sizeHint)	Create a new modifiable empty list of Resource objects, given a size hint.
ResourceList(java.util.Collection<Resource> resourceCollection)	Create a new modifiable empty ResourceList, given an initial collection of Resource objects.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,ResourceList>	asMap()	Return this ResourceList as a map from resource path (obtained from Resource.getPath()) to a ResourceList of Resource objects that have that path.
ResourceList	classFilesOnly()	Return a new ResourceList consisting of only the resources with the filename extension ".class".
void	close()	Close all the Resource objects in this ResourceList.
static ResourceList	emptyList()	Return an unmodifiable empty 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()	Find duplicate resource paths within this ResourceList.
void	forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer)	Deprecated. Use forEachByteArrayThrowingIOException(ByteArrayConsumerThrowsIOException) instead.
void	forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer, boolean ignoreIOExceptions)	Deprecated. Use forEachByteArrayIgnoringIOException(ByteArrayConsumer) or forEachByteArrayThrowingIOException(ByteArrayConsumerThrowsIOException) instead.
void	forEachByteArrayIgnoringIOException(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() for each Resource.
void	forEachByteArrayThrowingIOException(ResourceList.ByteArrayConsumerThrowsIOException byteArrayConsumerThrowsIOException)	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)	Deprecated. Use forEachByteBufferThrowingIOException(ByteBufferConsumerThrowsIOException) instead.
void	forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer, boolean ignoreIOExceptions)	Deprecated. Use forEachByteBufferIgnoringIOException(ByteBufferConsumer) or forEachByteBufferThrowingIOException(ByteBufferConsumerThrowsIOException) instead.
void	forEachByteBufferIgnoringIOException(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() for each Resource.
void	forEachByteBufferThrowingIOException(ResourceList.ByteBufferConsumerThrowsIOException byteBufferConsumerThrowsIOException)	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)	Deprecated. Use forEachInputStreamThrowingIOException(InputStreamConsumerThrowsIOException) instead.
void	forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer, boolean ignoreIOExceptions)	Deprecated. Use forEachInputStreamIgnoringIOException(InputStreamConsumer) or forEachInputStreamThrowingIOException(InputStreamConsumerThrowsIOException) instead.
void	forEachInputStreamIgnoringIOException(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() for each Resource.
void	forEachInputStreamThrowingIOException(ResourceList.InputStreamConsumerThrowsIOException inputStreamConsumerThrowsIOException)	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().
ResourceList	get(java.lang.String resourcePath)	Returns a list of all resources with the requested path.
java.util.List<java.lang.String>	getPaths()	Get the paths of all resources in this list relative to the package root.
java.util.List<java.lang.String>	getPathsRelativeToClasspathElement()	Get the paths of all resources in this list relative to the root of the classpath element.
java.util.List<java.net.URI>	getURIs()	Get the URIs of all resources in this list, by calling Resource.getURI() for each item in the list.
java.util.List<java.net.URL>	getURLs()	Get the URLs of all resources in this list, by calling Resource.getURL() for each item in the list.
ResourceList	nonClassFilesOnly()	Return a new ResourceList consisting of non-classfile resources only.

Methods inherited from class io.github.classgraph.PotentiallyUnmodifiableList

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

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.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Field Detail

serialVersionUID

static final long serialVersionUID

serialVersionUID.

See Also:

Constant Field Values

EMPTY_LIST

static final ResourceList EMPTY_LIST

An unmodifiable empty ResourceList.

CLASSFILE_FILTER

private static final ResourceList.ResourceFilter CLASSFILE_FILTER

Returns true if a Resource has a path ending in ".class".

Constructor Detail

ResourceList

public ResourceList()

Create a new modifiable empty list of Resource objects.

ResourceList

public ResourceList(int sizeHint)

Create a new modifiable empty list of Resource objects, given a size hint.

Parameters:

sizeHint - the size hint

ResourceList

public ResourceList(java.util.Collection<Resource> resourceCollection)

Create a new modifiable empty ResourceList, given an initial collection of Resource objects.

Parameters:

resourceCollection - the collection of Resource objects.

Method Detail

emptyList

public static ResourceList emptyList()

Return an unmodifiable empty ResourceList.

Returns:

the unmodifiable empty ResourceList.

get

public ResourceList get(java.lang.String resourcePath)

Returns a list of all resources with the requested path. (There may be more than one resource with a given path, from different classpath elements or modules, so this returns a ResourceList rather than a single Resource.)

Parameters:

resourcePath - The path of a resource

Returns:

A ResourceList of Resource objects in this list that have the given path (there may be more than one resource with a given path, from different classpath elements or modules, so this returns a ResourceList rather than a single Resource.) Returns the empty list if no resource with is found with a matching path.

getPaths

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

Get the paths of all resources in this list relative to the package root.

Returns:

The paths of all resources in this list relative to the package root, by calling Resource.getPath() for each item in the list.

getPathsRelativeToClasspathElement

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

Get the paths of all resources in this list relative to the root of the classpath element.

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.

getURLs

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

Get the URLs of all resources in this list, by calling Resource.getURL() for each item in the list. Note that any resource with a jrt: URI (e.g. a system resource, or a resource from a jlink'd image) will cause IllegalArgumentException to be thrown, since URL does not support this scheme, so getURIs() is strongly preferred over getURLs().

Returns:

The URLs of all resources in this list.

getURIs

public java.util.List<java.net.URI> getURIs()

Get the URIs of all resources in this list, by calling Resource.getURI() for each item in the list.

Returns:

The URIs of all resources in this list.

classFilesOnly

public ResourceList classFilesOnly()

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

Returns:

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

nonClassFilesOnly

public ResourceList nonClassFilesOnly()

Return a new ResourceList consisting of non-classfile resources only.

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()

Return this ResourceList as a map from resource path (obtained from Resource.getPath()) to a ResourceList of Resource objects that have that path.

Returns:

This ResourceList as a map from resource 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()

Find duplicate resource paths within this ResourceList.

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

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

Deprecated.

Use forEachByteArrayIgnoringIOException(ByteArrayConsumer) or forEachByteArrayThrowingIOException(ByteArrayConsumerThrowsIOException) instead.

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

@Deprecated
public void forEachByteArray(ResourceList.ByteArrayConsumer byteArrayConsumer)

Deprecated.

Use forEachByteArrayThrowingIOException(ByteArrayConsumerThrowsIOException) instead.

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 an IOException is thrown while trying to load any of the resources.

forEachByteArrayIgnoringIOException

public void forEachByteArrayIgnoringIOException(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() for each Resource. If an IOException occurs while opening or reading from any resource, the resource is silently skipped.

Parameters:

byteArrayConsumer - The ResourceList.ByteArrayConsumer.

forEachByteArrayThrowingIOException

public void forEachByteArrayThrowingIOException(ResourceList.ByteArrayConsumerThrowsIOException byteArrayConsumerThrowsIOException)
                                         throws java.io.IOException

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:

byteArrayConsumerThrowsIOException - The ResourceList.ByteArrayConsumerThrowsIOException.

Throws:

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

forEachInputStream

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

Deprecated.

Use forEachInputStreamIgnoringIOException(InputStreamConsumer) or forEachInputStreamThrowingIOException(InputStreamConsumerThrowsIOException) instead.

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() for each Resource.

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

@Deprecated
public void forEachInputStream(ResourceList.InputStreamConsumer inputStreamConsumer)

Deprecated.

Use forEachInputStreamThrowingIOException(InputStreamConsumerThrowsIOException) instead.

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() for each Resource.

Parameters:

inputStreamConsumer - The ResourceList.InputStreamConsumer.

Throws:

java.lang.IllegalArgumentException - an IOException is thrown while trying to open any of the resources.

forEachInputStreamIgnoringIOException

public void forEachInputStreamIgnoringIOException(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() for each Resource. If an IOException occurs while opening or reading from any resource, the resource is silently skipped.

Parameters:

inputStreamConsumer - The ResourceList.InputStreamConsumer.

forEachInputStreamThrowingIOException

public void forEachInputStreamThrowingIOException(ResourceList.InputStreamConsumerThrowsIOException inputStreamConsumerThrowsIOException)
                                           throws java.io.IOException

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:

inputStreamConsumerThrowsIOException - The ResourceList.InputStreamConsumerThrowsIOException.

Throws:

java.io.IOException - if trying to open or read from any of the resources results in an IOException being thrown.

forEachByteBuffer

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

Deprecated.

Use forEachByteBufferIgnoringIOException(ByteBufferConsumer) or forEachByteBufferThrowingIOException(ByteBufferConsumerThrowsIOException) instead.

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() for each Resource.

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

@Deprecated
public void forEachByteBuffer(ResourceList.ByteBufferConsumer byteBufferConsumer)

Deprecated.

Use forEachByteBufferThrowingIOException(ByteBufferConsumerThrowsIOException) instead.

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() for each Resource.

Parameters:

byteBufferConsumer - The ResourceList.ByteBufferConsumer.

Throws:

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

forEachByteBufferIgnoringIOException

public void forEachByteBufferIgnoringIOException(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() for each Resource. If an IOException occurs while opening or reading from any resource, the resource is silently skipped.

Parameters:

byteBufferConsumer - The ResourceList.ByteBufferConsumer.

forEachByteBufferThrowingIOException

public void forEachByteBufferThrowingIOException(ResourceList.ByteBufferConsumerThrowsIOException byteBufferConsumerThrowsIOException)
                                          throws java.io.IOException

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:

byteBufferConsumerThrowsIOException - The ResourceList.ByteBufferConsumerThrowsIOException.

Throws:

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

close

public void close()

Close all the Resource objects in this ResourceList.

Specified by:

close in interface java.lang.AutoCloseable