org.apache.bcel.classfile

Class SourceFile

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

Constructor Summary
SourceFile(SourceFile c)
Initialize from another object.
SourceFile(int name_index, int length, int sourcefile_index, ConstantPool constant_pool)
Method Summary
voidaccept(Visitor v)
Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class.
Attributecopy(ConstantPool _constant_pool)
voiddump(DataOutputStream file)
Dump source file attribute to file stream in binary format.
intgetSourceFileIndex()
StringgetSourceFileName()
voidsetSourceFileIndex(int sourcefile_index)
StringtoString()

Constructor Detail

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.

SourceFile

public SourceFile(int name_index, int length, int sourcefile_index, ConstantPool constant_pool)

Parameters: name_index Index in constant pool to CONSTANT_Utf8, which should represent the string "SourceFile". length Content length in bytes, the value should be 2. constant_pool The constant pool that this attribute is associated with. sourcefile_index 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.

Method Detail

accept

public void accept(Visitor v)
Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class. I.e., the hierarchy of methods, fields, attributes, etc. spawns a tree of objects.

Parameters: v Visitor object

copy

public Attribute copy(ConstantPool _constant_pool)

Returns: deep copy of this attribute

dump

public final void dump(DataOutputStream file)
Dump source file attribute to file stream in binary format.

Parameters: file Output file stream

Throws: IOException

getSourceFileIndex

public final int getSourceFileIndex()

Returns: Index in constant pool of source file name.

getSourceFileName

public final String getSourceFileName()

Returns: Source file name.

setSourceFileIndex

public final void setSourceFileIndex(int sourcefile_index)

Parameters: sourcefile_index

toString

public final String toString()

Returns: String representation