jp.vmi.selenium.selenese.command

Class AbstractCommand

java.lang.Object

jp.vmi.selenium.selenese.command.AbstractCommand

All Implemented Interfaces:

ICommand

Direct Known Subclasses:

AddCollection, AddLocationStrategy, AddSelection, AddToCollection, AllowNativeXpath, AltKeyDown, AltKeyUp, AnswerOnNextPrompt, Assertion, AssignId, AttachFile, BuiltInCommand, CaptureEntirePageScreenshot, Check, ChooseCancelOnNextConfirmation, ChooseOkOnNextConfirmation, Click, ClickAt, Close, Comment, ControlKeyDown, ControlKeyUp, CreateCookie, DeleteAllVisibleCookies, DeleteCookie, DeselectPopUp, DoubleClick, DragAndDrop, DragAndDropToObject, Echo, EndLoopImpl, FireEvent, Focus, GoBack, GotoIf, Gotolabel, Highlight, Include, KeyDown, KeyPress, KeyUp, Label, MetaKeyDown, MetaKeyUp, Open, OpenWindow, Pause, Refresh, RemoveAllSelections, RemoveSelection, Rollup, RunScript, Select, SelectFrame, SelectPopUp, SelectWindow, SetCursorPosition, SetSpeed, SetTimeout, ShiftKeyDown, ShiftKeyUp, StartLoopImpl, Store, Submit, Type, TypeKeys, Uncheck, UseXpathLibrary, WaitForCondition, WaitForPageToLoad, WaitForPopUp, WindowFocus, WindowMaximize

public abstract class AbstractCommand
extends Object
implements ICommand

Base implementation of command.

Constructor Summary

Constructors

Constructor and Description
AbstractCommand(int index, String name, String[] args, ArgumentType... argTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addScreenshot(String path, String label) Add screenshot image.
String[]	convertLocators(String[] args) Deprecated.
Result	execute(Context context, String... curArgs) Execute the command.
protected abstract Result	executeImpl(Context context, String... curArgs)
Locator[]	extractLocators(String[] args) Extract locators from arguments.
String[]	getArguments() Get command arguments.
int	getIndex() Get index in selenese script file (1 origin).
String	getName() Get command name.
Result	getResult() Get the command result.
List<Screenshot>	getScreenshots() Get list of screenshot images.
String[]	getSource() Get source elements.
StartLoop	getStartLoop() Get beginning-of-loop command.
boolean	mayUpdateScreen() May the command update screen?
void	setStartLoop(StartLoop startLoop) Set beginning-of-loop command.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommand

public AbstractCommand(int index,
                       String name,
                       String[] args,
                       ArgumentType... argTypes)

Constructor.

Parameters:

index - command index.

name - command name.

args - command args.

argTypes - command argument types.

Method Detail

getSource

public final String[] getSource()

Description copied from interface: ICommand

Get source elements.

Specified by:

getSource in interface ICommand

Returns:

array of source elements. (always 3 elements)

getIndex

public int getIndex()

Description copied from interface: ICommand

Get index in selenese script file (1 origin).

Specified by:

getIndex in interface ICommand

Returns:

index.

getName

public String getName()

Description copied from interface: ICommand

Get command name.

Specified by:

getName in interface ICommand

Returns:

command name.

getArguments

public String[] getArguments()

Description copied from interface: ICommand

Get command arguments.

Specified by:

getArguments in interface ICommand

Returns:

command arguments.

convertLocators

@Deprecated
public String[] convertLocators(String[] args)

Deprecated.

Description copied from interface: ICommand

Convert locators from arguments.

Specified by:

convertLocators in interface ICommand

Parameters:

args - the command arguments.

Returns:

converted locators.

extractLocators

public Locator[] extractLocators(String[] args)

Description copied from interface: ICommand

Extract locators from arguments.

Specified by:

extractLocators in interface ICommand

Parameters:

args - the command arguments.

Returns:

extracted parsed locators.

mayUpdateScreen

public boolean mayUpdateScreen()

Description copied from interface: ICommand

May the command update screen?

Specified by:

mayUpdateScreen in interface ICommand

Returns:

true if the command may update screen.

executeImpl

protected abstract Result executeImpl(Context context,
                                      String... curArgs)

execute

public final Result execute(Context context,
                            String... curArgs)

Description copied from interface: ICommand

Execute the command.

Note: set the command result to testCase in this method.

Specified by:

execute in interface ICommand

Parameters:

context - Selenese Runner context.

curArgs - current arugments. (the variables in it are extracted)

Returns:

the command result.

getResult

public Result getResult()

Description copied from interface: ICommand

Get the command result.

Specified by:

getResult in interface ICommand

Returns:

the command result.

setStartLoop

public void setStartLoop(StartLoop startLoop)

Description copied from interface: ICommand

Set beginning-of-loop command.

Specified by:

setStartLoop in interface ICommand

Parameters:

startLoop - beginning-of-loop command.

getStartLoop

public StartLoop getStartLoop()

Description copied from interface: ICommand

Get beginning-of-loop command.

Specified by:

getStartLoop in interface ICommand

Returns:

beginning-of-loop command.

addScreenshot

public void addScreenshot(String path,
                          String label)

Description copied from interface: ICommand

Add screenshot image.

Specified by:

addScreenshot in interface ICommand

Parameters:

path - image path.

label - image label.

getScreenshots

public List<Screenshot> getScreenshots()

Description copied from interface: ICommand

Get list of screenshot images.

Specified by:

getScreenshots in interface ICommand

Returns:

list of image path of sreenshot.

toString

public String toString()

Overrides:

toString in class Object