Class EnumElementValueGen

java.lang.Object

org.apache.bcel.generic.ElementValueGen

org.apache.bcel.generic.EnumElementValueGen

public class EnumElementValueGen
extends ElementValueGen

Generates enum element values in annotations.

Since:

6.0

Field Summary

Fields inherited from class ElementValueGen

ANNOTATION, ARRAY, CLASS, cpGen, ENUM_CONSTANT, PRIMITIVE_BOOLEAN, PRIMITIVE_BYTE, PRIMITIVE_CHAR, PRIMITIVE_DOUBLE, PRIMITIVE_FLOAT, PRIMITIVE_INT, PRIMITIVE_LONG, PRIMITIVE_SHORT, STRING, type

Modifier and Type	Field	Description
static final int	ANNOTATION	Element value type: annotation.
static final int	ARRAY	Element value type: array.
static final int	CLASS	Element value type: class.
protected ConstantPoolGen	cpGen	Deprecated. (since 6.0) will be made private and final; do not access directly, use getter
static final int	ENUM_CONSTANT	Element value type: enum constant.
static final int	PRIMITIVE_BOOLEAN	Element value type: primitive boolean.
static final int	PRIMITIVE_BYTE	Element value type: primitive byte.
static final int	PRIMITIVE_CHAR	Element value type: primitive char.
static final int	PRIMITIVE_DOUBLE	Element value type: primitive double.
static final int	PRIMITIVE_FLOAT	Element value type: primitive float.
static final int	PRIMITIVE_INT	Element value type: primitive int.
static final int	PRIMITIVE_LONG	Element value type: primitive long.
static final int	PRIMITIVE_SHORT	Element value type: primitive short.
static final int	STRING	Element value type: string.
protected int	type	Deprecated. (since 6.0) will be made private and final; do not access directly, use getter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EnumElementValueGen(int typeIdx, int valueIdx, ConstantPoolGen cpool)	This constructor assumes the constant pool already contains the right type and value - as indicated by typeIdx and valueIdx.
	EnumElementValueGen(EnumElementValue value, ConstantPoolGen cpool, boolean copyPoolEntries)	Constructs an EnumElementValueGen from an EnumElementValue.
	EnumElementValueGen(ObjectType t, String value, ConstantPoolGen cpool)	Constructs an EnumElementValueGen.

Method Summary

Modifier and Type	Method	Description
void	dump(DataOutputStream dos)	Dumps this element value to a DataOutputStream.
ElementValue	getElementValue()	Gets an immutable variant of this EnumElementValueGen.
String	getEnumTypeString()	Gets the enum type string.
String	getEnumValueString()	Gets the enum value string.
int	getTypeIndex()	Gets the type index.
int	getValueIndex()	Gets the value index.
String	stringifyValue()	Returns a string representation of the element value.

Methods inherited from class ElementValueGen

copy, getConstantPool, getElementValueType, readElementValue

Modifier and Type	Method	Description
static ElementValueGen	copy(ElementValue value, ConstantPoolGen cpool, boolean copyPoolEntries)	Creates an (modifiable) ElementValueGen copy of an (immutable) ElementValue - constant pool is assumed correct.
protected ConstantPoolGen	getConstantPool()	Gets the constant pool.
int	getElementValueType()	Gets the element value type.
static ElementValueGen	readElementValue(DataInput dis, ConstantPoolGen cpGen)	Reads an element value from a DataInput.

Methods inherited from class Object

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

Constructor Details

EnumElementValueGen

public EnumElementValueGen(EnumElementValue value,
 ConstantPoolGen cpool,
 boolean copyPoolEntries)

Constructs an EnumElementValueGen from an EnumElementValue.

Parameters:

value - The enum element value.

cpool - The constant pool.

copyPoolEntries - whether to copy pool entries.

EnumElementValueGen

protected EnumElementValueGen(int typeIdx,
 int valueIdx,
 ConstantPoolGen cpool)

This constructor assumes the constant pool already contains the right type and value - as indicated by typeIdx and valueIdx. This constructor is used for deserialization.

Parameters:

typeIdx - The type index.

valueIdx - The value index.

cpool - The constant pool.

EnumElementValueGen

public EnumElementValueGen(ObjectType t,
 String value,
 ConstantPoolGen cpool)

Constructs an EnumElementValueGen.

Parameters:

t - The object type.

value - The value.

cpool - The constant pool.

Method Details

dump

public void dump(DataOutputStream dos)
          throws IOException

Description copied from class: ElementValueGen

Dumps this element value to a DataOutputStream.

Specified by:

dump in class ElementValueGen

Parameters:

dos - The output stream.

Throws:

IOException - Thrown if an I/O error occurs.

getElementValue

public ElementValue getElementValue()

Gets an immutable variant of this EnumElementValueGen.

Specified by:

getElementValue in class ElementValueGen

Returns:

immutable variant.

getEnumTypeString

public String getEnumTypeString()

Gets the enum type string.

Returns:

The enum type string.

getEnumValueString

public String getEnumValueString()

Gets the enum value string.

Returns:

The enum value string.

getTypeIndex

public int getTypeIndex()

Gets the type index.

Returns:

The type index.

getValueIndex

public int getValueIndex()

Gets the value index.

Returns:

The value index.

stringifyValue

public String stringifyValue()

Description copied from class: ElementValueGen

Returns a string representation of the element value.

Specified by:

stringifyValue in class ElementValueGen

Returns:

A string representation of the element value.