org.apache.bcel.classfile
Class ConstantString

java.lang.Object
  extended by org.apache.bcel.classfile.Constant
      extended by org.apache.bcel.classfile.ConstantString
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, ConstantObject, Node

public final class ConstantString
extends Constant
implements ConstantObject

This class is derived from the abstract Constant class and represents a reference to a String object.

Version:
$Id: ConstantString.java 386056 2006-03-15 11:31:56Z tcurdt $
Author:
M. Dahm
See Also:
Constant, Serialized Form

Field Summary
private  int string_index
           
 
Fields inherited from class org.apache.bcel.classfile.Constant
tag
 
Constructor Summary
ConstantString(ConstantString c)
          Initialize from another object.
ConstantString(java.io.DataInputStream file)
          Initialize instance from file data.
ConstantString(int string_index)
           
 
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.
 void dump(java.io.DataOutputStream file)
          Dump constant field reference to file stream in binary format.
 java.lang.String getBytes(ConstantPool cp)
           
 java.lang.Object getConstantValue(ConstantPool cp)
           
 int getStringIndex()
           
 void setStringIndex(int string_index)
           
 java.lang.String toString()
           
 
Methods inherited from class org.apache.bcel.classfile.Constant
clone, copy, equals, getComparator, getTag, hashCode, readConstant, setComparator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

string_index

private int string_index
Constructor Detail

ConstantString

public ConstantString(ConstantString c)
Initialize from another object.


ConstantString

ConstantString(java.io.DataInputStream file)
         throws java.io.IOException
Initialize instance from file data.

Parameters:
file - Input stream
Throws:
java.io.IOException

ConstantString

public ConstantString(int string_index)
Parameters:
string_index - Index of Constant_Utf8 in 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 Constant
Parameters:
v - Visitor object

dump

public final void dump(java.io.DataOutputStream file)
                throws java.io.IOException
Dump constant field reference to file stream in binary format.

Specified by:
dump in class Constant
Parameters:
file - Output file stream
Throws:
java.io.IOException

getStringIndex

public final int getStringIndex()
Returns:
Index in constant pool of the string (ConstantUtf8).

setStringIndex

public final void setStringIndex(int string_index)
Parameters:
string_index - the index into the constant of the string value

toString

public final java.lang.String toString()
Overrides:
toString in class Constant
Returns:
String representation.

getConstantValue

public java.lang.Object getConstantValue(ConstantPool cp)
Specified by:
getConstantValue in interface ConstantObject
Returns:
String object

getBytes

public java.lang.String getBytes(ConstantPool cp)
Returns:
dereferenced string