Package org.apache.bcel.generic

Class BranchInstruction

    • Field Detail

      • index

        @Deprecated
protected int index
        Deprecated.
        (since 6.0) will be made private; do not access directly, use getter/setter

      • target

        @Deprecated
protected InstructionHandle target
        Deprecated.
        (since 6.0) will be made private; do not access directly, use getter/setter

      • position

        @Deprecated
protected int position
        Deprecated.
        (since 6.0) will be made private; do not access directly, use getter/setter

    • Constructor Detail

      • BranchInstruction

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

      • BranchInstruction

        protected BranchInstruction​(short opcode,
                            InstructionHandle target)
        Common super constructor
        Parameters:
        opcode - Instruction opcode.
        target - instruction to branch to.

    • Method Detail

      • containsTarget

        public boolean containsTarget​(InstructionHandle ih)
        Description copied from interface: InstructionTargeter
        Tests whether this targeter targets the specified instruction handle.
        Specified by:
        containsTarget in interface InstructionTargeter
        Parameters:
        ih - the instruction handle to test.
        Returns:
        true, if ih is target of this instruction.

      • dispose

        void dispose()
        Inform target that it's not targeted anymore.
        Overrides:
        dispose in class Instruction

      • dump

        public void dump​(java.io.DataOutputStream out)
          throws java.io.IOException
        Dumps instruction as byte code to stream out.
        Overrides:
        dump in class Instruction
        Parameters:
        out - Output stream.
        Throws:
        java.io.IOException - Thrown when an I/O exception of some sort has occurred.

      • getIndex

        public final int getIndex()
        Gets the target offset in byte code.
        Returns:
        target offset in byte code.

      • getPosition

        protected int getPosition()
        Gets the position.
        Returns:
        the position.
        Since:
        6.0

      • getTarget

        public InstructionHandle getTarget()
        Gets the target of branch instruction.
        Returns:
        target of branch instruction.

      • getTargetOffset

        protected int getTargetOffset()
        Gets the offset to this instruction's target.
        Returns:
        the offset to this instruction's target.

      • getTargetOffset

        protected int getTargetOffset​(InstructionHandle target)
        Gets the offset to target relative to this instruction.
        Parameters:
        target - branch target.
        Returns:
        the offset to 'target' relative to this instruction.

      • initFromFile

        protected void initFromFile​(ByteSequence bytes,
                            boolean wide)
                     throws java.io.IOException
        Reads needed data (for example index) from file. Conversion to a InstructionHandle is done in InstructionList(byte[]).
        Overrides:
        initFromFile in class Instruction
        Parameters:
        bytes - input stream.
        wide - wide prefix?
        Throws:
        java.io.IOException - may be thrown if the implementation needs to read data from the file
        See Also:
        InstructionList

      • setIndex

        protected void setIndex​(int index)
        Sets the index.
        Parameters:
        index - the index to set.
        Since:
        6.0

      • setPosition

        protected void setPosition​(int position)
        Sets the position.
        Parameters:
        position - the position to set.
        Since:
        6.0

      • setTarget

        public void setTarget​(InstructionHandle target)
        Sets branch target.
        Parameters:
        target - branch target.

      • toString

        public java.lang.String toString​(boolean verbose)
        Long output format: <position in byte code> <name of opcode> "["<opcode number>"]" "("<length of instruction>")" "<"<target instruction>">" "@"<branch target offset>
        Overrides:
        toString in class Instruction
        Parameters:
        verbose - long/short format switch.
        Returns:
        mnemonic for instruction.

      • updatePosition

        protected int updatePosition​(int offset,
                             int maxOffset)
        Called by InstructionList.setPositions when setting the position for every instruction. In the presence of variable length instructions 'setPositions' performs multiple passes over the instruction list to calculate the correct (byte) positions and offsets by calling this function.
        Parameters:
        offset - additional offset caused by preceding (variable length) instructions.
        maxOffset - the maximum offset that may be caused by these instructions.
        Returns:
        additional offset caused by possible change of this instruction's length.