Top Description Fields Constructors Methods
org.apache.bcel.generic

public abstract Class CPInstruction

extends Instruction
implements TypedInstruction, IndexedInstruction
Class Inheritance
All Implemented Interfaces
org.apache.bcel.generic.IndexedInstruction, org.apache.bcel.generic.TypedInstruction
Known Direct Subclasses
org.apache.bcel.generic.FieldOrMethod, org.apache.bcel.generic.INSTANCEOF, org.apache.bcel.generic.LDC, org.apache.bcel.generic.LDC2_W, org.apache.bcel.generic.MULTIANEWARRAY, org.apache.bcel.generic.NameSignatureInstruction, org.apache.bcel.generic.NEW, org.apache.bcel.generic.ANEWARRAY, org.apache.bcel.generic.CHECKCAST
Imports
java.io.DataOutputStream, .IOException, org.apache.bcel.classfile.Constant, .ConstantClass, .ConstantPool, .Utility, org.apache.bcel.util.ByteSequence
Abstract super class for instructions that use an index into the constant pool such as LDC, INVOKEVIRTUAL, etc.
See Also
ConstantPoolGen, LDC, INVOKEVIRTUAL

Field Summary

Modifier and TypeField and Description
protected int
index

Deprecated (since 6.0) will be made private; do not access directly, use getter/setter
Inherited from org.apache.bcel.generic.Instruction:
EMPTY_ARRAYlengthopcode

Constructor Summary

AccessConstructor and Description
pack-priv
CPInstruction()

Empty constructor needed for Instruction.readInstruction.

protected
CPInstruction(final short opcode, final int
to constant pool
index)

Method Summary

Modifier and TypeMethod and Description
public void
dump(final DataOutputStream
Output stream
out)

Overrides org.apache.bcel.generic.Instruction.dump.

Dump instruction as byte code to stream out.
public final int

Returns:

index in constant pool referred by this instruction.
getIndex()

Implements org.apache.bcel.generic.IndexedInstruction.getIndex.

public Type

Returns:

type related with this instruction.
getType(final ConstantPoolGen cpg)

Implements org.apache.bcel.generic.TypedInstruction.getType.

protected void
initFromFile(final ByteSequence
input stream
bytes, final boolean
wide prefix?
wide)

Overrides org.apache.bcel.generic.Instruction.initFromFile.

Read needed data (i.e., index) from file.
public void
setIndex(final int
in constant pool.
index)

Implements org.apache.bcel.generic.IndexedInstruction.setIndex.

Sets the index to constant pool.
public String

Returns:

mnemonic for instruction
toString(final boolean
long/short format switch
verbose)

Overrides org.apache.bcel.generic.Instruction.toString.

Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"< constant pool index>">"
public String

Returns:

mnemonic for instruction with symbolic references resolved
toString(final ConstantPool cp)

Overrides org.apache.bcel.generic.Instruction.toString.

Inherited from org.apache.bcel.generic.Instruction:
acceptconsumeStackcopydisposeequalsgetComparatorgetLengthgetNamegetOpcodehashCodeisValidByteisValidShortproduceStackreadInstructionsetComparatorsetLengthsetOpcodetoString

Field Detail

indexback to summary
protected int index

Deprecated

(since 6.0) will be made private; do not access directly, use getter/setter

Annotations
@Deprecated

Constructor Detail

CPInstructionback to summary
pack-priv CPInstruction()

Empty constructor needed for Instruction.readInstruction. Not to be used otherwise.

CPInstructionback to summary
protected CPInstruction(final short opcode, final int index)
Parameters
index:int

to constant pool

Method Detail

dumpback to summary
public void dump(final DataOutputStream out) throws IOException

Overrides org.apache.bcel.generic.Instruction.dump.

Dump instruction as byte code to stream out.

Parameters
out:DataOutputStream

Output stream

Annotations
@Override
Exceptions
IOException:

Doc from org.apache.bcel.generic.Instruction.dump.

Thrown when an I/O exception of some sort has occurred.

getIndexback to summary
public final int getIndex()

Implements org.apache.bcel.generic.IndexedInstruction.getIndex.

Returns:int

index in constant pool referred by this instruction.

Annotations
@Override
getTypeback to summary
public Type getType(final ConstantPoolGen cpg)

Implements org.apache.bcel.generic.TypedInstruction.getType.

Returns:Type

type related with this instruction.

Annotations
@Override
initFromFileback to summary
protected void initFromFile(final ByteSequence bytes, final boolean wide) throws IOException

Overrides org.apache.bcel.generic.Instruction.initFromFile.

Read needed data (i.e., index) from file.

Parameters
bytes:ByteSequence

input stream

wide:boolean

wide prefix?

Annotations
@Override
Exceptions
IOException:

Doc from org.apache.bcel.generic.Instruction.initFromFile.

may be thrown if the implementation needs to read data from the file

setIndexback to summary
public void setIndex(final int index)

Implements org.apache.bcel.generic.IndexedInstruction.setIndex.

Sets the index to constant pool.

Parameters
index:int

in constant pool.

Annotations
@Override
toStringback to summary
public String toString(final boolean verbose)

Overrides org.apache.bcel.generic.Instruction.toString.

Long output format: <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"< constant pool index>">"

Parameters
verbose:boolean

long/short format switch

Returns:String

mnemonic for instruction

Annotations
@Override
toStringback to summary
public String toString(final ConstantPool cp)

Overrides org.apache.bcel.generic.Instruction.toString.

Returns:String

mnemonic for instruction with symbolic references resolved

Annotations
@Override