abbot.script
Class Sequence

java.lang.Object
  abbot.script.Step
      abbot.script.Sequence

All Implemented Interfaces:

XMLConstants, XMLifiable, Serializable

Direct Known Subclasses:

Script

public class Sequence
extends Step

Script step which groups a sequence of other Steps. The sub-Steps have a fixed order and are executed in the order contained in the sequence. Events sent by sub-Steps are propagated by this one.

See Also:

Serialized Form

Field Summary

Fields inherited from interface abbot.script.XMLConstants

TAG_ACTION, TAG_APPLETVIEWER, TAG_ARCHIVE, TAG_ARGS, TAG_ASSERT, TAG_AWT, TAG_AWTTESTSCRIPT, TAG_BORDER_TITLE, TAG_CALL, TAG_CLASS, TAG_CLASSPATH, TAG_CODE, TAG_CODEBASE, TAG_COMMENT, TAG_COMPONENT, TAG_COUNT, TAG_DELEGATE, TAG_DESC, TAG_DOCBASE, TAG_EVENT, TAG_EXPR, TAG_FILENAME, TAG_FIXTURE, TAG_FORKED, TAG_HEIGHT, TAG_HORDER, TAG_ICON, TAG_ID, TAG_INDEX, TAG_INVERT, TAG_INVOKER, TAG_KEYCHAR, TAG_KEYCODE, TAG_KIND, TAG_LABEL, TAG_LAUNCH, TAG_METHOD, TAG_MODIFIERS, TAG_NAME, TAG_PARAMS, TAG_PARENT, TAG_POLL_INTERVAL, TAG_PROPERTY, TAG_ROOT, TAG_SAMPLE, TAG_SCRIPT, TAG_SEQUENCE, TAG_SLOW, TAG_STOP_ON_ERROR, TAG_STOP_ON_FAILURE, TAG_TAG, TAG_TERMINATE, TAG_TEXT, TAG_THREADED, TAG_TIMEOUT, TAG_TITLE, TAG_TRIGGER, TAG_TYPE, TAG_VALUE, TAG_VMARGS, TAG_VORDER, TAG_WAIT, TAG_WEIGHTED, TAG_WIDTH, TAG_WINDOW, TAG_X, TAG_Y

Constructor Summary

Sequence(Resolver resolver, Element el, Map atts)
Construct a Sequence from XML data.

Sequence(Resolver resolver, Map atts)

Sequence(Resolver resolver, String desc)

Sequence(Resolver resolver, String desc, List steps)
Create an aggregate from a list of existing Steps.

Method Summary

protected Element	addContent(Element el) Override if the step actually has some contents.
void	addStep(int index, Step step) Inserts a step at the given index in the sequence.
void	addStep(Step step) Adds a step to the end of the sequence.
void	clear() Remove all stepchildren.
String	getDefaultDescription() Return a reasonable default description for this script step.
Step	getStep(int index) Return the step at the given index in the sequence.
String	getUsage() Returns a string describing the proper XML usage for this class.
String	getXMLTag() Define the XML tag to use for this script step.
int	indexOf(Step step) Returns the index of the given step in the sequence, or -1 if the step is not in the sequence.
protected void	parseChild(Element el)
protected void	parseChildren(Element el)
void	removeStep(int index) Removes the step at the given index in the sequence.
void	removeStep(Step step) Removes the step if it exists in the sequence.
protected void	runStep() Process each event in our list.
protected void	runStep(StepRunner runner) Process each event in our list, using the given runner.
void	setStep(int index, Step step) Replaces the step at the given index.
int	size() Returns the number of steps contained in this one.
List	steps() Returns a list of the steps contained in this one.
String	toEditableString() Only thing directly editable on a sequence is its description.

Methods inherited from class abbot.script.Step

addAttributes, createAttributeMap, createStep, createStep, getAttributes, getDescription, getResolver, parseStepAttributes, resolveClass, resolveTester, run, setDescription, setScriptError, simpleClassName, toString, toXML, toXMLString, usage, usage

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence

public Sequence(Resolver resolver,
                Element el,
                Map atts)

Construct a Sequence from XML data.

Sequence

public Sequence(Resolver resolver,
                Map atts)

Sequence

public Sequence(Resolver resolver,
                String desc)

Sequence

public Sequence(Resolver resolver,
                String desc,
                List steps)

Create an aggregate from a list of existing Steps.

Method Detail

parseChild

protected void parseChild(Element el)
                   throws InvalidScriptException

Throws:

InvalidScriptException

parseChildren

protected void parseChildren(Element el)
                      throws InvalidScriptException

Throws:

InvalidScriptException

getDefaultDescription

public String getDefaultDescription()

Description copied from class: Step

Return a reasonable default description for this script step. This value is used in the absence of an explicit description.

Specified by:

getDefaultDescription in class Step

getXMLTag

public String getXMLTag()

Description copied from class: Step

Define the XML tag to use for this script step.

Specified by:

getXMLTag in class Step

addContent

protected Element addContent(Element el)

Description copied from class: Step

Override if the step actually has some contents. In most cases, it won't.

Overrides:

addContent in class Step

getUsage

public String getUsage()

Returns a string describing the proper XML usage for this class.

Specified by:

getUsage in class Step

toEditableString

public String toEditableString()

Only thing directly editable on a sequence is its description.

Specified by:

toEditableString in interface XMLifiable

Overrides:

toEditableString in class Step

runStep

protected void runStep()
                throws Throwable

Process each event in our list.

Specified by:

runStep in class Step

Throws:

Throwable

runStep

protected void runStep(StepRunner runner)
                throws Throwable

Process each event in our list, using the given runner.

Throws:

Throwable

size

public int size()

Returns the number of steps contained in this one.

clear

public void clear()

Remove all stepchildren. More effective than Cinderella's stepmother.

steps

public List steps()

Returns a list of the steps contained in this one.

indexOf

public int indexOf(Step step)

Returns the index of the given step in the sequence, or -1 if the step is not in the sequence.

getStep

public Step getStep(int index)

Return the step at the given index in the sequence.

addStep

public void addStep(int index,
                    Step step)

Inserts a step at the given index in the sequence.

addStep

public void addStep(Step step)

Adds a step to the end of the sequence.

setStep

public void setStep(int index,
                    Step step)

Replaces the step at the given index.

removeStep

public void removeStep(Step step)

Removes the step if it exists in the sequence.

removeStep

public void removeStep(int index)

Removes the step at the given index in the sequence.