Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| GNU Prolog for Java
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## gnu.prolog.vm.interpreter.instruction
Class ICut

    java.lang.Object
      gnu.prolog.vm.interpreter.instruction.Instruction
          gnu.prolog.vm.interpreter.instruction.ICut

All Implemented Interfaces:
  Installable

    public class ICut

extends Instruction

cut instruction

Field Summary
`int` | `environmentIndex` index in environment where cut position is kept, cut position is kept as JavaObjectTerm containing BacktrackInfo until which all should be be popped

Fields inherited from class gnu.prolog.vm.interpreter.instruction.Instruction
`codePosition`

Constructor Summary
`ICut(int environmentIndex)` a constructor

Method Summary
`int` | `execute(ExecutionState state, BacktrackInfo bi)` execute call instruction within specified sate
`String` | `toString()` convert instruction to string

Methods inherited from class gnu.prolog.vm.interpreter.instruction.Instruction
`install, uninstall`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### environmentIndex

    public int environmentIndex

  index in environment where cut position is kept, cut position is kept as JavaObjectTerm containing BacktrackInfo until which all should be be popped

Constructor Detail

### ICut

    public ICut(int environmentIndex)

  a constructor

  Parameters:
    `environmentIndex` -

Method Detail

### toString

    public String toString()

  convert instruction to string

  Overrides:
    `toString` in class `Object`

### execute

    public int execute(ExecutionState state,
                       BacktrackInfo bi)
                throws PrologException

  execute call instruction within specified sate

  Specified by:
    `execute` in class `Instruction`
  Parameters:
    `state` - state within which instruction will be executed
  Returns:
    instruction to caller how to execute next instruction
  Throws:
    `PrologException` - if code is throwing prolog exception

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| GNU Prolog for Java
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD