org.apache.bcel.classfile

Class SourceFile

Implemented Interfaces:
Cloneable, Node, Serializable

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.
Version:
$Id: SourceFile.java,v 1.3 2002/03/11 16:16:35 mdahm Exp $
Author:
M. Dahm
See Also:
Attribute

Field Summary

Fields inherited from class org.apache.bcel.classfile.Attribute

constant_pool, length, name_index, tag

Constructor Summary

SourceFile(int name_index, int length, int sourcefile_index, ConstantPool constant_pool)
SourceFile(SourceFile c)
Initialize from another object.

Method Summary

void
accept(Visitor v)
Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class.
Attribute
copy(ConstantPool constant_pool)
void
dump(DataOutputStream file)
Dump source file attribute to file stream in binary format.
int
getSourceFileIndex()
String
getSourceFileName()
void
setSourceFileIndex(int sourcefile_index)
String
toString()

Methods inherited from class org.apache.bcel.classfile.Attribute

accept, addAttributeReader, clone, copy, dump, getConstantPool, getLength, getNameIndex, getTag, readAttribute, removeAttributeReader, setConstantPool, setLength, setNameIndex, toString

Constructor Details

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

Method Details

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.
Specified by:
accept in interface Node
Overrides:
accept in interface Attribute
Parameters:
v - Visitor object

copy

public Attribute copy(ConstantPool constant_pool)
Overrides:
copy in interface Attribute
Returns:
deep copy of this attribute

dump

public final void dump(DataOutputStream file)
            throws IOException
Dump source file attribute to file stream in binary format.
Overrides:
dump in interface Attribute
Parameters:
file - Output file stream

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:

toString

public final String toString()
Overrides:
toString in interface Attribute
Returns:
String representation