yakscript.action
Class Goto

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

Direct Known Subclasses:

Sub

public class Goto

extends Action

Syntax: Goto <frame> [arguments...]

Changes to frame immediately, ignoring any actions that may be left in the current frame, and executing the new frame .init action if one exists. Any arguments given can be accessed from the next frame as variables, referred to in shell-script style as $1, $2, $3, etc. $0 represents name of the previous frame. All other variables are preserved.

Fields inherited from class yakscript.Action

arguments, condition

Constructor Summary

Goto()

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.
boolean	isInitial() Whether the initial action should be executed after this command Returns false by default, override this and return true if your keyword causes a switch to a new FrameState, eg.
void	setArguments(java.util.StringTokenizer _arguments) Set the arguments for this action and verify their contents Override this if you need to perform syntax checking on the arguments passed to your action

Methods inherited from class yakscript.Action

isCondition, setCondition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Goto

public Goto()

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

isInitial

public boolean isInitial()

Description copied from class: Action

Whether the initial action should be executed after this command
Returns false by default, override this and return true if your keyword causes a switch to a new FrameState, eg. Goto, Sub

Overrides:

isInitial in class Action

Following copied from class: yakscript.Action

Returns:

true if frame.init should be executed

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

setArguments

public void setArguments(java.util.StringTokenizer _arguments)
                  throws SyntaxErrorException

Description copied from class: Action

Set the arguments for this action and verify their contents
Override this if you need to perform syntax checking on the arguments passed to your action

Overrides:

setArguments in class Action

Following copied from class: yakscript.Action

Parameters:

args - Arguments to pass

Throws:

SyntaxErrorException - Thrown if the arguments are syntactically invalid for this action

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