org.macroing.cel4j.java.binary.classfile.cpinfo

Class ConstantPackageInfo

java.lang.Object

org.macroing.cel4j.java.binary.classfile.CPInfo

org.macroing.cel4j.java.binary.classfile.cpinfo.ConstantPackageInfo

All Implemented Interfaces:

Node

public final class ConstantPackageInfo
extends CPInfo

A ConstantPackageInfo denotes a CONSTANT_Package_info structure in the constant_pool of a ClassFile structure.

The CONSTANT_Package_info structure was added to Java in version 9.

This class is not thread-safe.

Since:

1.0.0

Author:

Jörgen Lundgren

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The name of the CONSTANT_Package_info structure.
static int	TAG The tag for CONSTANT_Package.

Method Summary

Modifier and Type	Method and Description
ConstantPackageInfo	copy() Returns a copy of this ConstantPackageInfo instance.
boolean	equals(java.lang.Object object) Returns true if, and only if, object is an instance of ConstantPackageInfo, and that ConstantPackageInfo instance is equal to this ConstantPackageInfo instance, false otherwise.
static java.util.List<ConstantPackageInfo>	filter(Node node) Returns a List with all ConstantPackageInfos.
int	getNameIndex() Returns the name_index of this ConstantPackageInfo instance.
int	hashCode() Returns a hash code for this ConstantPackageInfo instance.
static ConstantPackageInfo	newInstance(int nameIndex) Returns a new ConstantPackageInfo.
void	setNameIndex(int nameIndex) Sets a new name_index for this ConstantPackageInfo instance.
java.lang.String	toString() Returns a String representation of this ConstantPackageInfo instance.
void	write(java.io.DataOutput dataOutput) Writes this ConstantPackageInfo to dataOutput.
void	write(Document document) Writes this ConstantPackageInfo to document.

Methods inherited from class org.macroing.cel4j.java.binary.classfile.CPInfo

getConstantPoolEntryCount, getName, getTag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.macroing.cel4j.java.binary.node.Node

accept, accept

Field Detail

NAME

public static final java.lang.String NAME

The name of the CONSTANT_Package_info structure.

See Also:

Constant Field Values

TAG

public static final int TAG

The tag for CONSTANT_Package.

See Also:

Constant Field Values

Method Detail

copy

public ConstantPackageInfo copy()

Returns a copy of this ConstantPackageInfo instance.

Specified by:

copy in class CPInfo

Returns:

a copy of this ConstantPackageInfo instance

toString

public java.lang.String toString()

Returns a String representation of this ConstantPackageInfo instance.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this ConstantPackageInfo instance

equals

public boolean equals(java.lang.Object object)

Returns true if, and only if, object is an instance of ConstantPackageInfo, and that ConstantPackageInfo instance is equal to this ConstantPackageInfo instance, false otherwise.

Overrides:

equals in class java.lang.Object

Parameters:

object - an Object to compare to this ConstantPackageInfo instance for equality

Returns:

true if, and only if, object is an instance of ConstantPackageInfo, and that ConstantPackageInfo instance is equal to this ConstantPackageInfo instance, false otherwise

getNameIndex

public int getNameIndex()

Returns the name_index of this ConstantPackageInfo instance.

Returns:

the name_index of this ConstantPackageInfo instance

hashCode

public int hashCode()

Returns a hash code for this ConstantPackageInfo instance.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code for this ConstantPackageInfo instance

setNameIndex

public void setNameIndex(int nameIndex)

Sets a new name_index for this ConstantPackageInfo instance.

If nameIndex is less than or equal to 0, an IllegalArgumentException will be thrown.

Parameters:

nameIndex - the new name_index for this ConstantPackageInfo instance

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, nameIndex is less than or equal to 0

write

public void write(java.io.DataOutput dataOutput)

Writes this ConstantPackageInfo to dataOutput.

If dataOutput is an OutputStream (or any other type of stream), this method will not close it.

If dataOutput is null, a NullPointerException will be thrown.

If an I/O-error occurs, an UncheckedIOException will be thrown.

Specified by:

write in class CPInfo

Parameters:

dataOutput - the DataOutput to write to

Throws:

java.lang.NullPointerException - thrown if, and only if, dataOutput is null

java.io.UncheckedIOException - thrown if, and only if, an I/O-error occurs

write

public void write(Document document)

Writes this ConstantPackageInfo to document.

If document is null, a NullPointerException may be thrown. But no guarantees can be made.

Specified by:

write in class CPInfo

Parameters:

document - the Document to write to

Throws:

java.lang.NullPointerException - thrown if, and only if, document is null

newInstance

public static ConstantPackageInfo newInstance(int nameIndex)

Returns a new ConstantPackageInfo.

If nameIndex is less than or equal to 0, an IllegalArgumentException will be thrown.

Parameters:

nameIndex - the name_index of the new ConstantPackageInfo instance

Returns:

a new ConstantPackageInfo

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, nameIndex is less than or equal to 0

filter

public static java.util.List<ConstantPackageInfo> filter(Node node)

Returns a List with all ConstantPackageInfos.

All ConstantPackageInfos are found by traversing node using a simple NodeHierarchicalVisitor implementation.

If node is null, a NullPointerException will be thrown.

Parameters:

node - the Node to start traversal from

Returns:

a List with all ConstantPackageInfos

Throws:

java.lang.NullPointerException - thrown if, and only if, node is null