io.earcam.instrumental.module.jpms

Interface ModuleInfo

All Superinterfaces:

Serializable

public interface ModuleInfo
extends Serializable

Method Summary

Modifier and Type	Method and Description
int	access()
ModuleInfoBuilder	deconstruct()
Set<Export>	exports()
static Optional<ModuleInfo>	extract(JarInputStream jar) Extracts a module-info from a JarInputStream.
static Optional<ModuleInfo>	extract(Path jar) Extracts a module-info from a JAR (zip or directory-as-exploded-JAR)
String	mainClass()
default Set<ModuleModifier>	modifiers()
static ModuleInfoBuilder	moduleInfo()
String	name()
Set<Export>	opens()
SortedSet<CharSequence>	packages()
Map<String,String[]>	provides()
static ModuleInfo	read(byte[] bytecode) Read a module-info.class
static ModuleInfo	read(InputStream bytecode) Read a module-info.class.
Set<Require>	requires()
byte[]	toBytecode()
SortedSet<String>	uses()
String	version()

Method Detail

moduleInfo

static ModuleInfoBuilder moduleInfo()

Returns:

a new ModuleInfoBuilder.

read

static ModuleInfo read(byte[] bytecode)

Read a module-info.class

Parameters:

bytecode - the binary for module-info.class

Returns:

a ModuleInfo object.

read

static ModuleInfo read(@WillNotClose
                       InputStream bytecode)
                throws IOException

Read a module-info.class. The InputStream will not be closed, allowing use coding inspecting JarInputStream entries.

Parameters:

bytecode - the InputStream, which at current point contains module-info.class

Returns:

a ModuleInfo object.

Throws:

IOException - if any.

extract

static Optional<ModuleInfo> extract(Path jar)
                             throws IOException

Extracts a module-info from a JAR (zip or directory-as-exploded-JAR)

Parameters:

jar - path to the JAR

Returns:

a ModuleInfo instance, possibly SYNTHETIC, or Optional.empty() if no module-info can be derived.

Throws:

IOException

See Also:

#read(byte[])} to just read a {@code module-info.class} file

extract

static Optional<ModuleInfo> extract(@WillClose
                                    JarInputStream jar)
                             throws IOException

Extracts a module-info from a JarInputStream.

Parameters:

jar - the JAR input stream.

Returns:

a ModuleInfo instance, possibly SYNTHETIC, or Optional.empty() if no module-info can be derived.

Throws:

IOException

name

@Nonnull
String name()

Returns:

the module's name.

version

@Nullable
String version()

Returns:

the module's version.

access

int access()

Returns:

the module's access flags.

modifiers

default Set<ModuleModifier> modifiers()

Returns:

the module's modifiers.

packages

SortedSet<CharSequence> packages()

Returns:

the module's packages.

uses

SortedSet<String> uses()

Returns:

the module's uses.

provides

Map<String,String[]> provides()

Returns:

the module's provides.

mainClass

String mainClass()

Returns:

the module's main-class to launch.

requires

Set<Require> requires()

Returns:

the module's requires.

exports

Set<Export> exports()

Returns:

the module's exports.

opens

Set<Export> opens()

Returns:

the module's opens.

toBytecode

byte[] toBytecode()

Returns:

convert this model to bytecode.

deconstruct

ModuleInfoBuilder deconstruct()

Returns:

a mutable version of this model.