com.levigo.jadice.document.instruction

Interface Instruction

All Known Implementing Classes:

ChangePageLayoutInstruction, DocumentByWeakRefInstruction, FitInstruction, PageByIndexInstruction, PageByWeakRefInstruction, PanInstruction, RotateInstruction, TargetStringInstruction, URIInstruction, ZoomInstruction

public interface Instruction

An instruction describes something to be done. This can be displaying a page, sending an email or cooking a delicious meal. It summarises only the most important key data to turn the instruction into action, but it never executes the instruction. Instructions will be executed by realisations of InstructionExecutor.

Instructions describe their objective in a very abstract way. It is up to the InstructionExecutor to decide how to act upon this instruction in a manner that fits with the current environment. An Instruction does not specify the execution process as such; it only describes the goal to be reached and provides the necessary key data therefore.

Instructions are intended as immutable value objects. Implementations must provide useful equals() and hashCode() methods. A decent toString() implementation is encouraged.

Method Summary

Modifier and Type	Method and Description
String	getType()

Method Detail

getType

String getType()