yakscript.action
Class Exit

java.lang.Object
  |
  +--yakscript.Action
        |
        +--yakscript.action.Exit

public class Exit
extends Action

Syntax: Exit

Terminates the script immediately.


Fields inherited from class yakscript.Action
arguments, condition
 
Constructor Summary
Exit()
           
 
Method Summary
 boolean exec(YakScript ys)
          Executes this action
Override this to actually provide the functionality of your action
 java.lang.String getKeyword()
          Return the keyword of this action
 boolean isFinal()
          Whether execution of the current action should stop after this command Returns false by default, override this and return true if the action permanently goes to a new state (eg.
 
Methods inherited from class yakscript.Action
isCondition, isInitial, setArguments, setCondition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Exit

public Exit()
Method Detail

getKeyword

public java.lang.String getKeyword()
Description copied from class: Action
Return the keyword of this action
Overrides:
getKeyword in class Action
Following copied from class: yakscript.Action
Returns:
Keyword string

isFinal

public boolean isFinal()
Description copied from class: Action
Whether execution of the current action should stop after this command Returns false by default, override this and return true if the action permanently goes to a new state (eg. Goto, Load, Exit but not Sub)
Overrides:
isFinal in class Action
Following copied from class: yakscript.Action
Returns:
true if execution of current action should stop

exec

public boolean exec(YakScript ys)
Description copied from class: Action
Executes this action
Override this to actually provide the functionality of your action
Overrides:
exec in class Action
Following copied from class: yakscript.Action
Parameters:
yakScript - Currently executing instance of YakScript
Returns:
Whether command execution was successful