ClassGraph 4.8.179 · io.github.classgraph.ModuleReaderProxy

Modifier and Type	Field and Description
private static Class<?>	collectorClass Class<collector> collectorClass = Class.forName("java.util.stream.Collector");
private static Object	collectorsToList Collector<object, ?, list collectorsToList = Collectors.toList();
private final AutoCloseable	moduleReader The module reader.
private ReflectionUtils	reflectionUtils

Access	Constructor and Description
pack-priv	ModuleReaderProxy(final ModuleRef the module ref moduleRef) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Calls ModuleReader#close().
public URI	Returns: A `URI` for the resource. find(final String The path to the resource to open. path) Use the proxied ModuleReader to find the named resource as a URI.
public List<String>	Returns: A list of the paths of resources in the module. list() Get the list of resources accessible to a ModuleReader.
public InputStream	Returns: An `InputStream` for the content of the resource. open(final String The path to the resource to open. path) Use the proxied ModuleReader to open the named resource as an InputStream.
public ByteBuffer	Returns: A `ByteBuffer` for the content of the resource. read(final String The path to the resource to open. path) Use the proxied ModuleReader to open the named resource as a ByteBuffer.
public void	release(final ByteBuffer The `ByteBuffer` to release. byteBuffer) Release a `ByteBuffer` allocated by calling `read(String)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

collectorClass	back to summary
private static Class<?> collectorClass Class collectorClass = Class.forName("java.util.stream.Collector");

collectorsToList	back to summary
private static Object collectorsToList Collector> collectorsToList = Collectors.toList();

moduleReader	back to summary
private final AutoCloseable moduleReader The module reader.

reflectionUtils	back to summary
private ReflectionUtils reflectionUtils

ModuleReaderProxy	back to summary
pack-priv ModuleReaderProxy(final ModuleRef moduleRef) throws IOException Constructor. Parameters moduleRef:ModuleRef the module ref Exceptions IOException: If an I/O exception occurs.

Method Detail

close	back to summary
public void close() Implements java.io.Closeable.close. Calls ModuleReader#close(). Annotations @Override

back to summary

public void close()

Implements java.io.Closeable.close.

Calls ModuleReader#close().

Annotations

@Override

find back to summary

find	back to summary
public URI find(final String path) Use the proxied ModuleReader to find the named resource as a URI. Parameters path:String The path to the resource to open. Returns:URI A `URI` for the resource. Exceptions SecurityException: If the module cannot be accessed.

public URI find(final String path)

Use the proxied ModuleReader to find the named resource as a URI.

Parameters

path:String: The path to the resource to open.

Returns:URI

A URI for the resource.

Exceptions

SecurityException:: If the module cannot be accessed.

list	back to summary
public List<String> list() throws SecurityException Get the list of resources accessible to a ModuleReader. From the documentation for ModuleReader#list(): "Whether the stream of elements includes names corresponding to directories in the module is module reader specific. In lazy implementations then an IOException may be thrown when using the stream to list the module contents. If this occurs then the IOException will be wrapped in an java.io.UncheckedIOException and thrown from the method that caused the access to be attempted. SecurityException may also be thrown when using the stream to list the module contents and access is denied by the security manager." Returns:List<String> A list of the paths of resources in the module. Exceptions SecurityException: If the module cannot be accessed.

list

back to summary

public List<String> list() throws SecurityException

Get the list of resources accessible to a ModuleReader. From the documentation for ModuleReader#list(): "Whether the stream of elements includes names corresponding to directories in the module is module reader specific. In lazy implementations then an IOException may be thrown when using the stream to list the module contents. If this occurs then the IOException will be wrapped in an java.io.UncheckedIOException and thrown from the method that caused the access to be attempted. SecurityException may also be thrown when using the stream to list the module contents and access is denied by the security manager."

Returns:List<String>

A list of the paths of resources in the module.

Exceptions

SecurityException:: If the module cannot be accessed.

open back to summary

open	back to summary
public InputStream open(final String path) throws SecurityException Use the proxied ModuleReader to open the named resource as an InputStream. Parameters path:String The path to the resource to open. Returns:InputStream An `InputStream` for the content of the resource. Exceptions SecurityException: If the module cannot be accessed. IllegalArgumentException: If the module cannot be accessed.

public InputStream open(final String path) throws SecurityException

Use the proxied ModuleReader to open the named resource as an InputStream.

Parameters

path:String: The path to the resource to open.

Returns:InputStream

An InputStream for the content of the resource.

Exceptions

SecurityException:: If the module cannot be accessed.
IllegalArgumentException:: If the module cannot be accessed.

read back to summary

read	back to summary
public ByteBuffer read(final String path) throws SecurityException, OutOfMemoryError Use the proxied ModuleReader to open the named resource as a ByteBuffer. Call `release(ByteBuffer)` when you have finished with the ByteBuffer. Parameters path:String The path to the resource to open. Returns:ByteBuffer A `ByteBuffer` for the content of the resource. Exceptions SecurityException: If the module cannot be accessed. OutOfMemoryError: if the resource is larger than 2GB, the maximum capacity of a byte buffer.

public ByteBuffer read(final String path) throws SecurityException, OutOfMemoryError

Use the proxied ModuleReader to open the named resource as a ByteBuffer. Call release(ByteBuffer) when you have finished with the ByteBuffer.

Parameters

path:String: The path to the resource to open.

Returns:ByteBuffer

A ByteBuffer for the content of the resource.

Exceptions

SecurityException:: If the module cannot be accessed.
OutOfMemoryError:: if the resource is larger than 2GB, the maximum capacity of a byte buffer.

release back to summary

release	back to summary
public void release(final ByteBuffer byteBuffer) Release a `ByteBuffer` allocated by calling `read(String)`. Parameters byteBuffer:ByteBuffer The `ByteBuffer` to release.

public void release(final ByteBuffer byteBuffer)

Release a ByteBuffer allocated by calling read(String).

Parameters

byteBuffer:ByteBuffer: The ByteBuffer to release.

public Class ModuleReaderProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail