Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> bcel >> [ classfile overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.bcel.classfile
Class SourceFile  

java.lang.Object
  org.apache.bcel.classfile.Attribute
      org.apache.bcel.classfile.SourceFile

All Implemented Interfaces:

java.lang.Cloneable, Node, java.io.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 386056 2006-03-15 11:31:56Z tcurdt $

---

Field Summary
private  int	sourcefile_index

 

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

constant_pool, length, name_index, tag

 

Constructor Summary
(package private)	SourceFile(int name_index, int length, java.io.DataInputStream file, ConstantPool constant_pool)           Construct object from file stream.
	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(java.io.DataOutputStream file)           Dump source file attribute to file stream in binary format.
int	getSourceFileIndex()
java.lang.String	getSourceFileName()
void	setSourceFileIndex(int sourcefile_index)
java.lang.String	toString()           Convert this Object to a human-readable String.

 

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

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

 

Methods inherited from class java.lang.Object

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

 

Field Detail

sourcefile_index

private int sourcefile_index

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

SourceFile(int name_index,
           int length,
           java.io.DataInputStream file,
           ConstantPool constant_pool)
     throws java.io.IOException

Construct object from file stream.

---

SourceFile

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

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.

Specified by:

accept in interface Node

Specified by:

accept in class Attribute

---

dump

public final void dump(java.io.DataOutputStream file)
                throws java.io.IOException

Dump source file attribute to file stream in binary format.

Overrides:

dump in class Attribute

---

getSourceFileIndex

public final int getSourceFileIndex()

---

setSourceFileIndex

public final void setSourceFileIndex(int sourcefile_index)

---

getSourceFileName

public final java.lang.String getSourceFileName()

---

toString

public final java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in class Attribute

---

copy

public Attribute copy(ConstantPool _constant_pool)

Specified by:

copy in class Attribute

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> bcel >> [ classfile overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---