Module org.glavo.classfile

Package org.glavo.classfile.attribute

Interface ModuleAttribute

All Superinterfaces:

Attribute<ModuleAttribute>, ClassElement, ClassFileElement, WritableElement<ModuleAttribute>

All Known Implementing Classes:

BoundAttribute.BoundModuleAttribute, UnboundAttribute.UnboundModuleAttribute

public sealed interface ModuleAttribute
extends Attribute<ModuleAttribute>, ClassElement
permits BoundAttribute.BoundModuleAttribute, UnboundAttribute.UnboundModuleAttribute

Models the Module attribute , which can appear on classes that represent module descriptors. Delivered as a ClassElement when traversing the elements of a ClassModel.

The attribute does not permit multiple instances in a given location. Subsequent occurrence of the attribute takes precedence during the attributed element build or transformation.

The attribute was introduced in the Java SE Platform version 9.

Since:

22

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ModuleAttribute.ModuleAttributeBuilder	A builder for module attributes.

Method Summary

Modifier and Type	Method	Description
List<ModuleExportInfo>	exports()	Returns the packages exported by this module.
default boolean	has(AccessFlag flag)	Tests presence of module flag
default Set<AccessFlag>	moduleFlags()	Returns the the module flags of the module, as a set of enum constants.
int	moduleFlagsMask()	Returns the the module flags of the module, as a bit mask.
ModuleEntry	moduleName()	Returns the name of the module.
Optional<Utf8Entry>	moduleVersion()	Returns the version of the module, if present.
static ModuleAttribute	of(ModuleDesc moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)	Returns a Module attribute.
static ModuleAttribute	of(ModuleEntry moduleName, int moduleFlags, Utf8Entry moduleVersion, Collection<ModuleRequireInfo> requires, Collection<ModuleExportInfo> exports, Collection<ModuleOpenInfo> opens, Collection<ClassEntry> uses, Collection<ModuleProvideInfo> provides)	Returns a Module attribute.
static ModuleAttribute	of(ModuleEntry moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)	Returns a Module attribute.
List<ModuleOpenInfo>	opens()	Returns the packages opened by this module.
List<ModuleProvideInfo>	provides()	Returns the service implementations provided by this module.
List<ModuleRequireInfo>	requires()	Returns the modules required by this module.
List<ClassEntry>	uses()	Returns the services used by this module.

Methods inherited from interface org.glavo.classfile.Attribute

attributeMapper, attributeName

Methods inherited from interface org.glavo.classfile.WritableElement

writeTo

Method Details

moduleName

ModuleEntry moduleName()

Returns the name of the module.

Returns:

the name of the module

moduleFlagsMask

int moduleFlagsMask()

Returns the the module flags of the module, as a bit mask.

Returns:

the the module flags of the module, as a bit mask

moduleFlags

default Set<AccessFlag> moduleFlags()

Returns the the module flags of the module, as a set of enum constants.

Returns:

the the module flags of the module, as a set of enum constants

has

default boolean has(AccessFlag flag)

Tests presence of module flag

Parameters:

flag - the module flag

Returns:

true if the flag is set

moduleVersion

Optional<Utf8Entry> moduleVersion()

Returns the version of the module, if present.

Returns:

the version of the module, if present

requires

List<ModuleRequireInfo> requires()

Returns the modules required by this module.

Returns:

the modules required by this module

exports

List<ModuleExportInfo> exports()

Returns the packages exported by this module.

Returns:

the packages exported by this module

opens

List<ModuleOpenInfo> opens()

Returns the packages opened by this module.

Returns:

the packages opened by this module

uses

List<ClassEntry> uses()

Returns the services used by this module. Services may be discovered via ServiceLoader.

Returns:

the services used by this module

provides

List<ModuleProvideInfo> provides()

Returns the service implementations provided by this module.

Returns:

the service implementations provided by this module

of

static ModuleAttribute of(ModuleEntry moduleName,
 int moduleFlags,
 Utf8Entry moduleVersion,
 Collection<ModuleRequireInfo> requires,
 Collection<ModuleExportInfo> exports,
 Collection<ModuleOpenInfo> opens,
 Collection<ClassEntry> uses,
 Collection<ModuleProvideInfo> provides)

Returns a Module attribute.

Parameters:

moduleName - the module name

moduleFlags - the module flags

moduleVersion - the module version

requires - the required packages

exports - the exported packages

opens - the opened packages

uses - the consumed services

provides - the provided services

Returns:

a Module attribute

of

static ModuleAttribute of(ModuleDesc moduleName,
 Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)

Returns a Module attribute.

Parameters:

moduleName - the module name

attrHandler - a handler that receives a ModuleAttribute.ModuleAttributeBuilder

Returns:

a Module attribute

of

static ModuleAttribute of(ModuleEntry moduleName,
 Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)

Returns a Module attribute.

Parameters:

moduleName - the module name

attrHandler - a handler that receives a ModuleAttribute.ModuleAttributeBuilder

Returns:

a Module attribute