Class Module

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.Module

All Implemented Interfaces:

Cloneable, Node

public final class Module
extends Attribute

This class is derived from Attribute and represents the list of modules required, exported, opened or provided by a module. There may be at most one Module attribute in a ClassFile structure.

Since:

6.4.0

See Also:

• Attribute

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION	The module file name extension.

Fields inherited from class Attribute

constant_pool, EMPTY_ARRAY, length, name_index, tag

Modifier and Type	Field	Description
protected ConstantPool	constant_pool	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
static final Attribute[]	EMPTY_ARRAY	Empty array.
protected int	length	Deprecated. (since 6.0) (since 6.0) will be made private; do not access directly, use getter/setter.
protected int	name_index	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.
protected byte	tag	Deprecated. (since 6.0) will be made private; do not access directly, use getter/setter.

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor v)	Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.
Attribute	copy(ConstantPool constantPool)	Creates a deep copy of this attribute.
void	dump(DataOutputStream file)	Dumps Module attribute to file stream in binary format.
ModuleExports[]	getExportsTable()	Gets the table of exported interfaces.
int	getModuleFlags()	Gets flags for this module.
String	getModuleName(ConstantPool cp)	Gets module name.
ModuleOpens[]	getOpensTable()	Gets the table of open interfaces.
ModuleProvides[]	getProvidesTable()	Gets the table of provided interfaces.
ModuleRequires[]	getRequiresTable()	Gets the table of required modules.
String[]	getUsedClassNames(ConstantPool constantPool, boolean compactClassName)	Gets the array of class names for this module's uses.
String	getVersion(ConstantPool cp)	Gets version for this module.
String	toString()

Methods inherited from class Attribute

addAttributeReader, addAttributeReader, clone, getConstantPool, getLength, getName, getNameIndex, getTag, println, readAttribute, readAttribute, readAttribute, removeAttributeReader, setConstantPool, setLength, setNameIndex

Modifier and Type	Method	Description
static void	addAttributeReader(String name, AttributeReader attributeReader)	Deprecated. (6.0) Use Attribute.addAttributeReader(String, UnknownAttributeReader) instead.
static void	addAttributeReader(String name, UnknownAttributeReader unknownAttributeReader)	Add an Attribute reader capable of parsing (user-defined) attributes named "name".
Object	clone()	Use copy() if you want to have a deep copy(), that is, with all references copied correctly.
final ConstantPool	getConstantPool()	Gets the constant pool used by this object.
final int	getLength()	Gets the length of attribute field in bytes.
String	getName()	Gets the name of the attribute.
final int	getNameIndex()	Gets the name index in constant pool of attribute name.
final byte	getTag()	Gets the tag of attribute, that is, its type.
protected static void	println(String msg)	Prints a message to stderr if debug mode is enabled.
static Attribute	readAttribute(DataInput dataInput, ConstantPool constantPool)	Reads one attribute using standard eight-byte Code headers.
static Attribute	readAttribute(DataInput dataInput, ConstantPool constantPool, boolean compactCodeHeader)	Reads one attribute using the selected Code header layout.
static Attribute	readAttribute(DataInputStream dataInputStream, ConstantPool constantPool)	Reads one attribute using standard eight-byte Code headers.
static void	removeAttributeReader(String name)	Remove attribute reader
final void	setConstantPool(ConstantPool constantPool)	Sets the constant pool to be used for this object.
final void	setLength(int length)	Sets the length in bytes.
final void	setNameIndex(int nameIndex)	Sets the name index of attribute.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

EXTENSION

public static final String EXTENSION

The module file name extension.

Since:

6.7.0

See Also:

• Constant Field Values

Method Details

accept

public void accept(Visitor v)

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class. That is, the hierarchy of methods, fields, attributes, and other elements forms a tree of objects.

Specified by:

accept in interface Node

Specified by:

accept in class Attribute

Parameters:

v - Visitor object.

copy

public Attribute copy(ConstantPool constantPool)

Description copied from class: Attribute

Creates a deep copy of this attribute.

Specified by:

copy in class Attribute

Parameters:

constantPool - constant pool to save.

Returns:

deep copy of this attribute.

dump

public void dump(DataOutputStream file)
          throws IOException

Dumps Module attribute to file stream in binary format.

Overrides:

dump in class Attribute

Parameters:

file - Output file stream.

Throws:

IOException - Thrown if an I/O error occurs.

getExportsTable

public ModuleExports[] getExportsTable()

Gets the table of exported interfaces.

Returns:

table of exported interfaces.

See Also:

• ModuleExports

getModuleFlags

public int getModuleFlags()

Gets flags for this module.

Returns:

module flags.

Since:

6.10.0

getModuleName

public String getModuleName(ConstantPool cp)

Gets module name.

Parameters:

cp - Array of constants.

Returns:

module name.

Since:

6.10.0

getOpensTable

public ModuleOpens[] getOpensTable()

Gets the table of open interfaces.

Returns:

table of provided interfaces.

See Also:

• ModuleOpens

getProvidesTable

public ModuleProvides[] getProvidesTable()

Gets the table of provided interfaces.

Returns:

table of provided interfaces.

See Also:

• ModuleProvides

getRequiresTable

public ModuleRequires[] getRequiresTable()

Gets the table of required modules.

Returns:

table of required modules.

See Also:

• ModuleRequires

getUsedClassNames

public String[] getUsedClassNames(ConstantPool constantPool,
 boolean compactClassName)

Gets the array of class names for this module's uses.

Parameters:

constantPool - Array of constants usually obtained from the ClassFile object.

compactClassName - false for original constant pool value, true to replace '/' with '.'.

Returns:

array of used class names.

Since:

6.10.0

getVersion

public String getVersion(ConstantPool cp)

Gets version for this module.

Parameters:

cp - Array of constants.

Returns:

version from constant pool, "0" if version index is 0.

Since:

6.10.0

toString

public String toString()

Overrides:

toString in class Attribute

Returns:

String representation, that is, a list of packages.