abbot.script

Class Comment

java.lang.Object

abbot.script.Step

abbot.script.Comment

All Implemented Interfaces:

XMLConstants, XMLifiable, java.io.Serializable

public class Comment
extends Step

Represents a comment. No other function.

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

Constructors

Constructor and Description
Comment(Resolver resolver, java.util.Map attributes)
Comment(Resolver resolver, java.lang.String description)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultDescription() Default to whitespace.
java.lang.String	getUsage() Provide a usage String for this step.
java.lang.String	getXMLTag() This is only used to generate the title label for the editor.
protected void	runStep() Main run step.
java.lang.String	toString() Return a description of this script step.
org.jdom.Element	toXML() Convert the object to XML.

Methods inherited from class abbot.script.Step

addAttributes, addContent, createAttributeMap, createStep, createStep, getAttributes, getDescription, getResolver, parseAttributes, resolveClass, resolveTester, run, setDescription, setScriptError, simpleClassName, toEditableString, toXMLString, usage, usage

Methods inherited from class java.lang.Object

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

Constructor Detail

Comment

public Comment(Resolver resolver,
       java.util.Map attributes)

Comment

public Comment(Resolver resolver,
       java.lang.String description)

Method Detail

getDefaultDescription

public java.lang.String getDefaultDescription()

Default to whitespace.

Specified by:

getDefaultDescription in class Step

toString

public java.lang.String toString()

Description copied from class: Step

Return a description of this script step.

Overrides:

toString in class Step

getUsage

public java.lang.String getUsage()

Description copied from class: Step

Provide a usage String for this step.

Specified by:

getUsage in class Step

getXMLTag

public java.lang.String getXMLTag()

This is only used to generate the title label for the editor.

Specified by:

getXMLTag in class Step

toXML

public org.jdom.Element toXML()

Description copied from class: Step

Convert the object to XML.

Specified by:

toXML in interface XMLifiable

Overrides:

toXML in class Step

runStep

protected void runStep()

Main run step.

Specified by:

runStep in class Step