APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.org.apache.bcel.internal.classfile

public final Class ConstantString

extends Constant
implements ConstantObject
Class Inheritance
All Implemented Interfaces
com.sun.org.apache.bcel.internal.classfile.ConstantObject
Imports
java.io.DataInput, .DataOutputStream, .IOException, com.sun.org.apache.bcel.internal.Const
This class is derived from the abstract Constant and represents a reference to a String object.
See Also
Constant

Field Summary

Modifier and TypeField and Description
private int
stringIndex

Inherited from com.sun.org.apache.bcel.internal.classfile.Constant:
EMPTY_ARRAYtag

Constructor Summary

AccessConstructor and Description
public
ConstantString(final ConstantString
Source to copy.
c)

Initialize from another object.

pack-priv
ConstantString(final DataInput
Input stream
file)

Initialize instance from file data.

public
ConstantString(final int
Index of Constant_Utf8 in constant pool
stringIndex)

Method Summary

Modifier and TypeMethod and Description
public void
accept(final Visitor
Visitor object
v)

Implements abstract com.sun.org.apache.bcel.internal.classfile.Constant.accept.

Implements com.sun.org.apache.bcel.internal.classfile.Node.accept.

Called by objects that are traversing the nodes of the tree implicitly defined by the contents of a Java class.

public void
dump(final DataOutputStream
Output file stream
file)

Implements abstract com.sun.org.apache.bcel.internal.classfile.Constant.dump.

Dump constant field reference to file stream in binary format.

public String
getBytes(final ConstantPool cp)

Returns: dereferenced string

public Object

Returns:

String object
getConstantValue(final ConstantPool cp)

Implements com.sun.org.apache.bcel.internal.classfile.ConstantObject.getConstantValue.

Gets the object representing the constant, e.g., Long for ConstantLong.

public int
getStringIndex()

Returns: Index in constant pool of the string (ConstantUtf8).

public void
setStringIndex(final int
the index into the constant of the string value
stringIndex)

public String

Returns:

String representation.
toString()

Overrides com.sun.org.apache.bcel.internal.classfile.Constant.toString.

Returns a string representation of the object.

Inherited from com.sun.org.apache.bcel.internal.classfile.Constant:
clonecopyequalsgetComparatorgetTaghashCodereadConstantsetComparator

Field Detail

stringIndexback to summary
private int stringIndex

Constructor Detail

ConstantStringback to summary
public ConstantString(final ConstantString c)

Initialize from another object.

Parameters
c:ConstantString

Source to copy.

ConstantStringback to summary
pack-priv ConstantString(final DataInput file) throws IOException

Initialize instance from file data.

Parameters
file:DataInput

Input stream

Exceptions
IOException:
if an I/O error occurs.
ConstantStringback to summary
public ConstantString(final int stringIndex)
Parameters
stringIndex:int

Index of Constant_Utf8 in constant pool

Method Detail

acceptback to summary
public void accept(final Visitor v)

Implements abstract com.sun.org.apache.bcel.internal.classfile.Constant.accept.

Implements com.sun.org.apache.bcel.internal.classfile.Node.accept.

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.

Parameters
v:Visitor

Visitor object

Annotations
@Override
dumpback to summary
public void dump(final DataOutputStream file) throws IOException

Implements abstract com.sun.org.apache.bcel.internal.classfile.Constant.dump.

Dump constant field reference to file stream in binary format.

Parameters
file:DataOutputStream

Output file stream

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
getBytesback to summary
public String getBytes(final ConstantPool cp)
Returns:String

dereferenced string

getConstantValueback to summary
public Object getConstantValue(final ConstantPool cp)

Implements com.sun.org.apache.bcel.internal.classfile.ConstantObject.getConstantValue.

Doc from com.sun.org.apache.bcel.internal.classfile.ConstantObject.getConstantValue.

Gets the object representing the constant, e.g., Long for ConstantLong.

Returns:Object

String object

Annotations
@Override
getStringIndexback to summary
public int getStringIndex()
Returns:int

Index in constant pool of the string (ConstantUtf8).

setStringIndexback to summary
public void setStringIndex(final int stringIndex)
Parameters
stringIndex:int

the index into the constant of the string value

toStringback to summary
public String toString()

Overrides com.sun.org.apache.bcel.internal.classfile.Constant.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

String representation.

Annotations
@Override