Class SourceFile

java.lang.Object

org.apache.bcel.classfile.Attribute

org.apache.bcel.classfile.SourceFile

All Implemented Interfaces:

Cloneable, Node

public final class SourceFile
extends Attribute

This class is derived from Attribute and represents a reference to the source file of this class. At most one SourceFile attribute should appear per classfile. The intention of this class is that it is instantiated from the Attribute.readAttribute() method.

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
SourceFile(int nameIndex, int length, int sourceFileIndex, ConstantPool constantPool)	Constructs a SourceFile.
SourceFile(SourceFile 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 copy of this attribute.
void	dump(DataOutputStream file)	Dumps source file attribute to file stream in binary format.
int	getSourceFileIndex()	Gets the source file index.
String	getSourceFileName()	Gets the source file name.
void	setSourceFileIndex(int sourceFileIndex)	Sets the source file index.
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

Constructor Details

SourceFile

public SourceFile(int nameIndex,
 int length,
 int sourceFileIndex,
 ConstantPool constantPool)

Constructs a SourceFile.

Parameters:

nameIndex - Index in constant pool to CONSTANT_Utf8, which should represent the string "SourceFile".

length - Content length in bytes, the value should be 2.

sourceFileIndex - Index in constant pool to CONSTANT_Utf8. This string will be interpreted as the name of the file from which this class was compiled. It will not be interpreted as indicating the name of the directory contqining the file or an absolute path; this information has to be supplied the consumer of this attribute - in many cases, the JVM.

constantPool - The constant pool that this attribute is associated with.

SourceFile

public SourceFile(SourceFile c)

Initialize from another object. Note that both objects use the same references (shallow copy). Use clone() 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)

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 source file 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.

getSourceFileIndex

public int getSourceFileIndex()

Gets the source file index.

Returns:

Index in constant pool of source file name.

getSourceFileName

public String getSourceFileName()

Gets the source file name.

Returns:

Source file name.

setSourceFileIndex

public void setSourceFileIndex(int sourceFileIndex)

Sets the source file index.

Parameters:

sourceFileIndex - The source file index to set.

toString

public String toString()

Overrides:

toString in class Attribute

Returns:

String representation.