java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

io.github.classgraph.ResourceList

All Implemented Interfaces:: Serializable, AutoCloseable, Cloneable, Iterable<Resource>, Collection<Resource>, List<Resource>, RandomAccess

public class ResourceList
extends ArrayList<T>
implements 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.

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(Collection<Resource> resourceCollection)`	Create a new modifiable empty `ResourceList`, given an initial collection of `Resource` objects.

Method Summary

Modifier and Type	Method	Description
`void`	`add(int index, T element)`
`boolean`	`add(T element)`
`boolean`	`addAll(int index, Collection<? extends T> c)`
`boolean`	`addAll(Collection<? extends T> c)`
`Map<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`	`clear()`
`void`	`close()`	Close all the `Resource` objects in this `ResourceList`.
`static ResourceList`	`emptyList()`	Return an unmodifiable empty `ResourceList`.
`boolean`	`equals(Object o)`
`ResourceList`	`filter(ResourceList.ResourceFilter filter)`	Find the subset of the `Resource` objects in this list for which the given filter predicate is true.
`List<Map.Entry<String,ResourceList>>`	`findDuplicatePaths()`	Find duplicate resource paths within this `ResourceList`.
`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()`.
`ResourceList`	`get(String resourcePath)`	Returns a list of all resources with the requested path.
`List<String>`	`getPaths()`	Get the paths of all resources in this list relative to the package root.
`List<String>`	`getPathsRelativeToClasspathElement()`	Get the paths of all resources in this list relative to the root of the classpath element.
`List<URI>`	`getURIs()`	Get the URIs of all resources in this list, by calling `Resource.getURI()` for each item in the list.
`List<URL>`	`getURLs()`	Get the URLs of all resources in this list, by calling `Resource.getURL()` for each item in the list.
`int`	`hashCode()`
`Iterator<T>`	`iterator()`
`ListIterator<T>`	`listIterator()`
`ResourceList`	`nonClassFilesOnly()`	Return a new `ResourceList` consisting of non-classfile resources only.
`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 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.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details
- 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(Collection<Resource> resourceCollection)
  
  Create a new modifiable empty ResourceList, given an initial collection of Resource objects.
  
  Parameters:
  
  resourceCollection - the collection of Resource objects.
Method Details
- emptyList
  
  public static ResourceList emptyList()
  
  Return an unmodifiable empty ResourceList.
  
  Returns:
  
  the unmodifiable empty ResourceList.
- get
  
  public ResourceList get(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 List<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 List<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 List<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 List<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 Map<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 List<Map.Entry<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
  
  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:
  
  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:
  
  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:
  
  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:
  
  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:
  
  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:
  
  IllegalArgumentException - 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 AutoCloseable
- equals
  
  public boolean equals(Object o)
  
  Specified by:
  
  equals in interface Collection<T>
  
  Specified by:
  
  equals in interface List<T>
  
  Overrides:
  
  equals in class ArrayList<T>
- hashCode
  
  public int hashCode()
  
  Specified by:
  
  hashCode in interface Collection<T>
  
  Specified by:
  
  hashCode in interface List<T>
  
  Overrides:
  
  hashCode in class ArrayList<T>
- 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 Collection<T>
  
  Specified by:
  
  iterator in interface Iterable<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>

Class ResourceList