Class EnclosingMethod

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.EnclosingMethod

All Implemented Interfaces:

Cloneable, Node

public class EnclosingMethod
extends Attribute

This attribute exists for local or anonymous classes and ... there can be only one.

Since:

6.0

Field Summary

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.
final void	dump(DataOutputStream file)	Dumps attribute to file stream in binary format.
final ConstantClass	getEnclosingClass()	Gets the enclosing class.
final int	getEnclosingClassIndex()	Gets the enclosing class index.
final ConstantNameAndType	getEnclosingMethod()	Gets the enclosing method.
final int	getEnclosingMethodIndex()	Gets the enclosing method index.
final void	setEnclosingClassIndex(int idx)	Sets the enclosing class index.
final void	setEnclosingMethodIndex(int idx)	Sets the enclosing method index.

Methods inherited from class Attribute

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

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.
String	toString()

Methods inherited from class Object

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

Method Details

accept

public void accept(Visitor v)

Description copied from class: Attribute

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 final void dump(DataOutputStream file)
                throws IOException

Description copied from class: Attribute

Dumps 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.

getEnclosingClass

public final ConstantClass getEnclosingClass()

Gets the enclosing class.

Returns:

The enclosing class.

getEnclosingClassIndex

public final int getEnclosingClassIndex()

Gets the enclosing class index.

Returns:

The enclosing class index.

getEnclosingMethod

public final ConstantNameAndType getEnclosingMethod()

Gets the enclosing method.

Returns:

The enclosing method.

getEnclosingMethodIndex

public final int getEnclosingMethodIndex()

Gets the enclosing method index.

Returns:

The enclosing method index.

setEnclosingClassIndex

public final void setEnclosingClassIndex(int idx)

Sets the enclosing class index.

Parameters:

idx - The index.

setEnclosingMethodIndex

public final void setEnclosingMethodIndex(int idx)

Sets the enclosing method index.

Parameters:

idx - The index.