Class PermittedSubclasses

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.PermittedSubclasses

All Implemented Interfaces:

Cloneable, Node

public final class PermittedSubclasses
extends Attribute

This class is derived from Attribute and records the classes and interfaces that are permitted to extend or implement the current class or interface. There may be at most one PermittedSubclasses attribute in a ClassFile structure.

Since:

6.13.0

See Also:

• Attribute

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.

Constructor Summary

Constructors

Constructor	Description
PermittedSubclasses(int nameIndex, int length, int[] classes, ConstantPool constantPool)	Constructs object from table of class indices in constant pool.
PermittedSubclasses(PermittedSubclasses c)	Initialize from another object.

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 clone of this object given constant pool.
void	dump(DataOutputStream file)	Dumps PermittedSubclasses attribute to file stream in binary format.
int[]	getClasses()	Gets the class indices in constant pool.
String[]	getClassNames()	Gets permitted class names.
int	getNumberClasses()	Gets the number of classes.
void	setClasses(int[] classes)	Sets class indices.
String	toString()	String representation of PermittedSubclasses (for debugging purposes).

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

Constructor Details

PermittedSubclasses

public PermittedSubclasses(int nameIndex,
 int length,
 int[] classes,
 ConstantPool constantPool)

Constructs object from table of class indices in constant pool.

Parameters:

nameIndex - Index in constant pool.

length - Content length in bytes.

classes - Table of indices in constant pool.

constantPool - Array of constants.

PermittedSubclasses

public PermittedSubclasses(PermittedSubclasses c)

Initialize from another object. Note that both objects use the same references (shallow copy). Use copy() for a physical copy.

Parameters:

c - Source to copy.

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)

Creates a deep clone of this object given constant pool.

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

getClasses

public int[] getClasses()

Gets the class indices in constant pool.

Returns:

array of indices into constant pool of class names.

getClassNames

public String[] getClassNames()

Gets permitted class names.

Returns:

string array of class names.

getNumberClasses

public int getNumberClasses()

Gets the number of classes.

Returns:

Length of classes table.

setClasses

public void setClasses(int[] classes)

Sets class indices.

Parameters:

classes - The list of class indexes Also redefines number_of_classes according to table length.

toString

public String toString()

String representation of PermittedSubclasses (for debugging purposes).

Overrides:

toString in class Attribute

Returns:

String representation, that is, a list of permitted subclasses.