Package org.apache.bcel.classfile

Class ConstantString

java.lang.Object

org.apache.bcel.classfile.Constant

org.apache.bcel.classfile.ConstantString

All Implemented Interfaces:

java.lang.Cloneable, ConstantObject, Node

public final class ConstantString
extends Constant
implements ConstantObject

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

See Also:

Constant

Field Summary

Fields

Modifier and Type	Field	Description
private int	stringIndex

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

EMPTY_ARRAY, tag

Constructor Summary

Constructors

Constructor	Description
ConstantString(int stringIndex)	Constructs a ConstantString.
ConstantString(java.io.DataInput file)	Initialize instance from file data.
ConstantString(ConstantString 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.
void	dump(java.io.DataOutputStream file)	Dumps constant field reference to file stream in binary format.
java.lang.String	getBytes(ConstantPool cp)	Gets the dereferenced string.
java.lang.Object	getConstantValue(ConstantPool cp)	Gets the String object.
int	getStringIndex()	Gets the index in constant pool of the string.
void	setStringIndex(int stringIndex)	Sets the 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

stringIndex

private int stringIndex

Constructor Detail

ConstantString

public ConstantString(ConstantString c)

Initialize from another object.

Parameters:

c - Source to copy.

ConstantString

ConstantString(java.io.DataInput file)
        throws java.io.IOException

Initialize instance from file data.

Parameters:

file - Input stream.

Throws:

java.io.IOException - if an I/O error occurs.

ConstantString

public ConstantString(int stringIndex)

Constructs a ConstantString.

Parameters:

stringIndex - 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 implicitly 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 void dump(java.io.DataOutputStream file)
          throws java.io.IOException

Dumps constant field reference to file stream in binary format.

Specified by:

dump in class Constant

Parameters:

file - Output file stream.

Throws:

java.io.IOException - if an I/O error occurs.

getBytes

public java.lang.String getBytes(ConstantPool cp)

Gets the dereferenced string.

Parameters:

cp - the constant pool.

Returns:

dereferenced string.

getConstantValue

public java.lang.Object getConstantValue(ConstantPool cp)

Gets the String object.

Specified by:

getConstantValue in interface ConstantObject

Parameters:

cp - the constant pool.

Returns:

String object.

getStringIndex

public int getStringIndex()

Gets the index in constant pool of the string.

Returns:

Index in constant pool of the string (ConstantUtf8).

setStringIndex

public void setStringIndex(int stringIndex)

Sets the string index.

Parameters:

stringIndex - the index into the constant of the string value.

toString

public java.lang.String toString()

Overrides:

toString in class Constant

Returns:

String representation.