Modifier and Type	Class and Description
pack-priv static class	ModuleReferences.ExplodedModuleReader A ModuleReader for an exploded module.
pack-priv static class	ModuleReferences.JarModuleReader A ModuleReader for a modular JAR file.
pack-priv static class	ModuleReferences.JModModuleReader A ModuleReader for a JMOD file.
pack-priv abstract static class	ModuleReferences.SafeCloseModuleReader A base module reader that encapsulates machinery required to close the module reader safely.

Access	Constructor and Description
private	ModuleReferences()

Modifier and Type	Method and Description
pack-priv static ModuleReference	newExplodedModule(ModuleInfo.Attributes attrs, ModulePatcher patcher, Path dir) Creates a ModuleReference to a possibly-patched exploded module.
pack-priv static ModuleReference	newJarModule(ModuleInfo.Attributes attrs, ModulePatcher patcher, Path file) Creates a ModuleReference to a possibly-patched module in a modular JAR.
pack-priv static ModuleReference	newJModModule(ModuleInfo.Attributes attrs, Path file) Creates a ModuleReference to a module in a JMOD file.
private static ModuleReference	newModule(ModuleInfo.Attributes attrs, URI uri, Supplier<ModuleReader> supplier, ModulePatcher patcher, ModuleHashes.HashSupplier hasher) Creates a ModuleReference to a possibly-patched module

ModuleReferences	back to summary
private ModuleReferences()

newExplodedModule	back to summary
pack-priv static ModuleReference newExplodedModule(ModuleInfo.Attributes attrs, ModulePatcher patcher, Path dir) Creates a ModuleReference to a possibly-patched exploded module.

newJarModule	back to summary
pack-priv static ModuleReference newJarModule(ModuleInfo.Attributes attrs, ModulePatcher patcher, Path file) Creates a ModuleReference to a possibly-patched module in a modular JAR.

newJModModule	back to summary
pack-priv static ModuleReference newJModModule(ModuleInfo.Attributes attrs, Path file) Creates a ModuleReference to a module in a JMOD file.

newModule	back to summary
private static ModuleReference newModule(ModuleInfo.Attributes attrs, URI uri, Supplier<ModuleReader> supplier, ModulePatcher patcher, ModuleHashes.HashSupplier hasher) Creates a ModuleReference to a possibly-patched module

pack-priv Class ModuleReferences.ExplodedModuleReader

Class Inheritance

java.lang.Object
jdk.internal.module.ModuleReferences.ExplodedModuleReader

All Implemented Interfaces

java.lang.module.ModuleReader, java.io.Closeable, java.lang.AutoCloseable

A ModuleReader for an exploded module.

Field Summary

Modifier and Type	Field and Description
private volatile boolean	closed
private final Path	dir

Constructor Summary

Access	Constructor and Description
pack-priv	ExplodedModuleReader(Path dir)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.module.ModuleReader.close. Closes the module reader.
private void	ensureOpen() Throws IOException if the module reader is closed;
public Optional<URI>	find(String name) Implements java.lang.module.ModuleReader.find. Finds a resource, returning a URI to the resource in the module.
public Stream<String>	list() Implements java.lang.module.ModuleReader.list. Lists the contents of the module, returning a stream of elements that are the names of all resources in the module.
public Optional<InputStream>	open(String name) Overrides default java.lang.module.ModuleReader.open. Opens a resource, returning an input stream to read the resource in the module.
public Optional<ByteBuffer>	read(String name) Overrides default java.lang.module.ModuleReader.read. Reads a resource, returning a byte buffer with the contents of the resource.

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

Field Detail

closed	back to summary
private volatile boolean closed

dir	back to summary
private final Path dir

Constructor Detail

ExplodedModuleReader	back to summary
pack-priv ExplodedModuleReader(Path dir)

Method Detail

close back to summary

close	back to summary
public void close() Implements java.lang.module.ModuleReader.close. Doc from java.lang.module.ModuleReader.close. Closes the module reader. Once closed then subsequent calls to locate or read a resource will fail by throwing `IOException`. A module reader is not required to be asynchronously closeable. If a thread is reading a resource and another thread invokes the close method, then the second thread may block until the read operation is complete. Annotations @Override

public void close()

Implements java.lang.module.ModuleReader.close.

Doc from java.lang.module.ModuleReader.close.

Closes the module reader. Once closed then subsequent calls to locate or read a resource will fail by throwing IOException.

A module reader is not required to be asynchronously closeable. If a thread is reading a resource and another thread invokes the close method, then the second thread may block until the read operation is complete.

Annotations

@Override

ensureOpen	back to summary
private void ensureOpen() throws IOException Throws IOException if the module reader is closed;

find	back to summary
public Optional<URI> find(String name) throws IOException Implements java.lang.module.ModuleReader.find. Doc from java.lang.module.ModuleReader.find. Finds a resource, returning a URI to the resource in the module. If the module reader can determine that the name locates a directory then the resulting URI will end with a slash ('/'). Annotations @Override Exceptions IOException: If an I/O error occurs or the module reader is closed

find

back to summary

public Optional<URI> find(String name) throws IOException

Implements java.lang.module.ModuleReader.find.

Doc from java.lang.module.ModuleReader.find.

Finds a resource, returning a URI to the resource in the module.

If the module reader can determine that the name locates a directory then the resulting URI will end with a slash ('/').

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

list back to summary

list	back to summary
public Stream<String> list() throws IOException Implements java.lang.module.ModuleReader.list. Doc from java.lang.module.ModuleReader.list. Lists the contents of the module, returning a stream of elements that are the names of all resources in the module. 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. The returned stream may contain references to one or more open directories in the module. The directories are closed by closing the stream. The behavior of the stream when used after the module reader is closed is implementation specific and therefore not specified. Annotations @Override Exceptions IOException: If an I/O error occurs or the module reader is closed

public Stream<String> list() throws IOException

Implements java.lang.module.ModuleReader.list.

Doc from java.lang.module.ModuleReader.list.

Lists the contents of the module, returning a stream of elements that are the names of all resources in the module. 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.

The returned stream may contain references to one or more open directories in the module. The directories are closed by closing the stream.

The behavior of the stream when used after the module reader is closed is implementation specific and therefore not specified.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

open	back to summary
public Optional<InputStream> open(String name) throws IOException Overrides default java.lang.module.ModuleReader.open. Doc from java.lang.module.ModuleReader.open. Opens a resource, returning an input stream to read the resource in the module. The behavior of the input stream when used after the module reader is closed is implementation specific and therefore not specified. Annotations @Override Exceptions IOException: If an I/O error occurs or the module reader is closed

open

back to summary

public Optional<InputStream> open(String name) throws IOException

Overrides default java.lang.module.ModuleReader.open.

Doc from java.lang.module.ModuleReader.open.

Opens a resource, returning an input stream to read the resource in the module.

The behavior of the input stream when used after the module reader is closed is implementation specific and therefore not specified.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

read back to summary

read	back to summary
public Optional<ByteBuffer> read(String name) throws IOException Overrides default java.lang.module.ModuleReader.read. Doc from java.lang.module.ModuleReader.read. Reads a resource, returning a byte buffer with the contents of the resource. The element at the returned buffer's position is the first byte of the resource, the element at the buffer's limit is the last byte of the resource. Once consumed, the `release` method must be invoked. Failure to invoke the `release` method may result in a resource leak. Annotations @Override Exceptions IOException: If an I/O error occurs or the module reader is closed

public Optional<ByteBuffer> read(String name) throws IOException

Overrides default java.lang.module.ModuleReader.read.

Doc from java.lang.module.ModuleReader.read.

Reads a resource, returning a byte buffer with the contents of the resource. The element at the returned buffer's position is the first byte of the resource, the element at the buffer's limit is the last byte of the resource. Once consumed, the release method must be invoked. Failure to invoke the release method may result in a resource leak.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

jdk.internal.module back to summary

pack-priv Class ModuleReferences.JarModuleReader

Class Inheritance

extends SafeCloseModuleReader

java.lang.Object
jdk.internal.module.ModuleReferences.SafeCloseModuleReader
jdk.internal.module.ModuleReferences.JarModuleReader

A ModuleReader for a modular JAR file.

Field Summary

Modifier and Type	Field and Description
private final JarFile	jf
private final URI	uri

Constructor Summary

Access	Constructor and Description
pack-priv	JarModuleReader(String path, URI uri)

Method Summary

Modifier and Type	Method and Description
private JarEntry	getEntry(String name)
pack-priv void	implClose() Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Closes the module reader.
pack-priv Optional<URI>	implFind(String name) Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Returns a URL to resource.
pack-priv Stream<String>	implList() Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Returns a stream of the names of resources in the module.
pack-priv Optional<InputStream>	implOpen(String name) Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Returns an input stream for reading a resource.
pack-priv static JarFile	newJarFile(String path)

Inherited from jdk.internal.module.ModuleReferences.SafeCloseModuleReader:: close find list open

Field Detail

jf	back to summary
private final JarFile jf

uri	back to summary
private final URI uri

Constructor Detail

JarModuleReader	back to summary
pack-priv JarModuleReader(String path, URI uri)

Method Detail

getEntry	back to summary
private JarEntry getEntry(String name)

implClose	back to summary
pack-priv void implClose() throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Closes the module reader. This method is invoked by close to do the actual work of closing the module reader. Annotations @Override

implClose

back to summary

pack-priv void implClose() throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose.

Closes the module reader. This method is invoked by close to do the actual work of closing the module reader.

Annotations

@Override

implFind	back to summary
pack-priv Optional<URI> implFind(String name) throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Returns a URL to resource. This method is invoked by the find method to do the actual work of finding the resource. Annotations @Override

implFind

back to summary

pack-priv Optional<URI> implFind(String name) throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind.

Returns a URL to resource. This method is invoked by the find method to do the actual work of finding the resource.

Annotations

@Override

implList	back to summary
pack-priv Stream<String> implList() throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Returns a stream of the names of resources in the module. This method is invoked by the list method to do the actual work of creating the stream. Annotations @Override

implList

back to summary

pack-priv Stream<String> implList() throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList.

Returns a stream of the names of resources in the module. This method is invoked by the list method to do the actual work of creating the stream.

Annotations

@Override

implOpen	back to summary
pack-priv Optional<InputStream> implOpen(String name) throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Returns an input stream for reading a resource. This method is invoked by the open method to do the actual work of opening an input stream to the resource. Annotations @Override

implOpen

back to summary

pack-priv Optional<InputStream> implOpen(String name) throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen.

Returns an input stream for reading a resource. This method is invoked by the open method to do the actual work of opening an input stream to the resource.

Annotations

@Override

newJarFile	back to summary
pack-priv static JarFile newJarFile(String path)

jdk.internal.module back to summary

pack-priv Class ModuleReferences.JModModuleReader

Class Inheritance

extends SafeCloseModuleReader

java.lang.Object
jdk.internal.module.ModuleReferences.SafeCloseModuleReader
jdk.internal.module.ModuleReferences.JModModuleReader

A ModuleReader for a JMOD file.

Field Summary

Modifier and Type	Field and Description
private final JmodFile	jf
private final URI	uri

Constructor Summary

Access	Constructor and Description
pack-priv	JModModuleReader(Path path, URI uri)

Method Summary

Modifier and Type	Method and Description
private JmodFile.Entry	getEntry(String name)
pack-priv void	implClose() Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Closes the module reader.
pack-priv Optional<URI>	implFind(String name) Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Returns a URL to resource.
pack-priv Stream<String>	implList() Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Returns a stream of the names of resources in the module.
pack-priv Optional<InputStream>	implOpen(String name) Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Returns an input stream for reading a resource.
pack-priv static JmodFile	newJmodFile(Path path)

Inherited from jdk.internal.module.ModuleReferences.SafeCloseModuleReader:: close find list open

Field Detail

jf	back to summary
private final JmodFile jf

uri	back to summary
private final URI uri

Constructor Detail

JModModuleReader	back to summary
pack-priv JModModuleReader(Path path, URI uri)

Method Detail

getEntry	back to summary
private JmodFile.Entry getEntry(String name)

implClose	back to summary
pack-priv void implClose() throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose. Closes the module reader. This method is invoked by close to do the actual work of closing the module reader. Annotations @Override

implClose

back to summary

pack-priv void implClose() throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implClose.

Closes the module reader. This method is invoked by close to do the actual work of closing the module reader.

Annotations

@Override

implFind	back to summary
pack-priv Optional<URI> implFind(String name) Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind. Returns a URL to resource. This method is invoked by the find method to do the actual work of finding the resource. Annotations @Override

implFind

back to summary

pack-priv Optional<URI> implFind(String name)

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implFind.

Returns a URL to resource. This method is invoked by the find method to do the actual work of finding the resource.

Annotations

@Override

implList	back to summary
pack-priv Stream<String> implList() throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList. Returns a stream of the names of resources in the module. This method is invoked by the list method to do the actual work of creating the stream. Annotations @Override

implList

back to summary

pack-priv Stream<String> implList() throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implList.

Returns a stream of the names of resources in the module. This method is invoked by the list method to do the actual work of creating the stream.

Annotations

@Override

implOpen	back to summary
pack-priv Optional<InputStream> implOpen(String name) throws IOException Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen. Returns an input stream for reading a resource. This method is invoked by the open method to do the actual work of opening an input stream to the resource. Annotations @Override

implOpen

back to summary

pack-priv Optional<InputStream> implOpen(String name) throws IOException

Implements abstract jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen.

Doc from jdk.internal.module.ModuleReferences.SafeCloseModuleReader.implOpen.

Returns an input stream for reading a resource. This method is invoked by the open method to do the actual work of opening an input stream to the resource.

Annotations

@Override

newJmodFile	back to summary
pack-priv static JmodFile newJmodFile(Path path)

jdk.internal.module back to summary

pack-priv abstract Class ModuleReferences.SafeCloseModuleReader

Class Inheritance

extends Object
implements ModuleReader

java.lang.Object
jdk.internal.module.ModuleReferences.SafeCloseModuleReader

All Implemented Interfaces

java.lang.module.ModuleReader, java.io.Closeable, java.lang.AutoCloseable

Known Direct Subclasses

jdk.internal.module.ModuleReferences.JarModuleReader, jdk.internal.module.ModuleReferences.JModModuleReader

A base module reader that encapsulates machinery required to close the module reader safely.

Field Summary

Modifier and Type	Field and Description
private boolean	closed
private final ReadWriteLock	lock
private final Lock	readLock
private final Lock	writeLock

Constructor Summary

Access	Constructor and Description
pack-priv	SafeCloseModuleReader()

Method Summary

Modifier and Type	Method and Description
public final void	close() Implements java.lang.module.ModuleReader.close. Closes the module reader.
public final Optional<URI>	find(String name) Implements java.lang.module.ModuleReader.find. Finds a resource, returning a URI to the resource in the module.
pack-priv abstract void	implClose() Closes the module reader.
pack-priv abstract Optional<URI>	implFind(String name) Returns a URL to resource.
pack-priv abstract Stream<String>	implList() Returns a stream of the names of resources in the module.
pack-priv abstract Optional<InputStream>	implOpen(String name) Returns an input stream for reading a resource.
public final Stream<String>	list() Implements java.lang.module.ModuleReader.list. Lists the contents of the module, returning a stream of elements that are the names of all resources in the module.
public final Optional<InputStream>	open(String name) Overrides default java.lang.module.ModuleReader.open. Opens a resource, returning an input stream to read the resource in the module.

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

Field Detail

closed	back to summary
private boolean closed

lock	back to summary
private final ReadWriteLock lock

readLock	back to summary
private final Lock readLock

writeLock	back to summary
private final Lock writeLock

Constructor Detail

SafeCloseModuleReader	back to summary
pack-priv SafeCloseModuleReader()

Method Detail

close back to summary

public final void close() throws IOException

Implements java.lang.module.ModuleReader.close.

Doc from java.lang.module.ModuleReader.close.

Closes the module reader. Once closed then subsequent calls to locate or read a resource will fail by throwing IOException.

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

find

back to summary

public final Optional<URI> find(String name) throws IOException

Implements java.lang.module.ModuleReader.find.

Doc from java.lang.module.ModuleReader.find.

Finds a resource, returning a URI to the resource in the module.

If the module reader can determine that the name locates a directory then the resulting URI will end with a slash ('/').

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

implClose	back to summary
pack-priv abstract void implClose() throws IOException Closes the module reader. This method is invoked by close to do the actual work of closing the module reader.

implFind	back to summary
pack-priv abstract Optional<URI> implFind(String name) throws IOException Returns a URL to resource. This method is invoked by the find method to do the actual work of finding the resource.

implList	back to summary
pack-priv abstract Stream<String> implList() throws IOException Returns a stream of the names of resources in the module. This method is invoked by the list method to do the actual work of creating the stream.

implOpen	back to summary
pack-priv abstract Optional<InputStream> implOpen(String name) throws IOException Returns an input stream for reading a resource. This method is invoked by the open method to do the actual work of opening an input stream to the resource.

list back to summary

public final Stream<String> list() throws IOException

Implements java.lang.module.ModuleReader.list.

Doc from java.lang.module.ModuleReader.list.

The returned stream may contain references to one or more open directories in the module. The directories are closed by closing the stream.

The behavior of the stream when used after the module reader is closed is implementation specific and therefore not specified.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

open

back to summary

public final Optional<InputStream> open(String name) throws IOException

Overrides default java.lang.module.ModuleReader.open.

Doc from java.lang.module.ModuleReader.open.

Opens a resource, returning an input stream to read the resource in the module.

The behavior of the input stream when used after the module reader is closed is implementation specific and therefore not specified.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs or the module reader is closed

pack-priv Class ModuleReferences

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class ModuleReferences.ExplodedModuleReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ModuleReferences.JarModuleReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ModuleReferences.JModModuleReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class ModuleReferences.SafeCloseModuleReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail