jp.vmi.selenium.selenese.command

Class Command

java.lang.Object

jp.vmi.selenium.selenese.command.Command

All Implemented Interfaces:

ICommand

Deprecated.

use AbstractCommand.

@Deprecated
public abstract class Command
extends Object
implements ICommand

Abstract class for implementing selenese command.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	args Deprecated.
protected String[]	locators Deprecated.
protected String	name Deprecated.

Constructor Summary

Constructors

Constructor and Description
Command(int index, String name, String[] args, int argCnt) Deprecated. Constructor.
Command(int index, String name, String[] args, int argCnt, int[] locatorIndexes) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	addScreenshot(String path, String label) Deprecated. Add screenshot image.
boolean	canUpdate() Deprecated. Can this command update screen?
String[]	convertLocators(String[] args) Deprecated. Convert locators from arguments.
Result	doCommand(TestCase testCase, Runner runner) Deprecated. Execute selenese command.
protected Result	doCommandImpl(TestCase testCase, Runner runner) Deprecated. Implementation of command.
Result	execute(Context context, String... curArgs) Deprecated. Execute the command.
String[]	getArguments() Deprecated. Get command arguments.
int	getIndex() Deprecated. Get index in selenese script file (1 origin).
String[]	getLocators() Deprecated. Get locators of command.
String	getName() Deprecated. Get command name.
Result	getResult() Deprecated. Get result of this command.
List<Screenshot>	getScreenshots() Deprecated. Get list of screenshot images.
String[]	getSource() Deprecated. Get source elements.
StartLoop	getStartLoop() Deprecated. Get beginning-of-loop command.
boolean	hasResult() Deprecated. Has this command result?
boolean	mayUpdateScreen() Deprecated. May the command update screen?
Command	next(TestCase testCase) Deprecated.
protected Result	setResult(Result result) Deprecated. Set result of this command.
void	setStartLoop(StartLoop startLoop) Deprecated. Set beginning-of-loop command.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

Deprecated.

args

protected final String[] args

Deprecated.

locators

protected final String[] locators

Deprecated.

Constructor Detail

Command

public Command(int index,
               String name,
               String[] args,
               int argCnt,
               int[] locatorIndexes)

Deprecated.

Constructor.

Parameters:

index - index number of Command. (1 origin)

name - selenese command name.

args - command arguments.

argCnt - argument count. (less than or equals to args.length)

locatorIndexes - locator indexes. (0 origin. use NO_LOCATOR_INDEX if no locator)

Command

public Command(int index,
               String name,
               String[] args,
               int argCnt)

Deprecated.

Constructor. (for command with no locator)

Parameters:

index - index number of Command. (1 origin)

name - selenese command name.

args - command arguments.

argCnt - argument count. (less than or equals to args.length)

Method Detail

hasResult

public boolean hasResult()

Deprecated.

Has this command result?

For example, "echo" and "comment" have no result.

Returns:

true if command has result.

canUpdate

public boolean canUpdate()

Deprecated.

Can this command update screen?

Returns:

true if command can update screen.

getIndex

public final int getIndex()

Deprecated.

Get index in selenese script file (1 origin).

Specified by:

getIndex in interface ICommand

Returns:

index.

getName

public String getName()

Deprecated.

Description copied from interface: ICommand

Get command name.

Specified by:

getName in interface ICommand

Returns:

command name.

getLocators

public String[] getLocators()

Deprecated.

Get locators of command.

Returns:

locators (array length is 0 if the command has no locator).

getResult

public final Result getResult()

Deprecated.

Get result of this command.

Specified by:

getResult in interface ICommand

Returns:

result of this command.

setResult

protected final Result setResult(Result result)

Deprecated.

Set result of this command.

Parameters:

result - result of this command.

Returns:

result itself.

getSource

public final String[] getSource()

Deprecated.

Get source elements.

Specified by:

getSource in interface ICommand

Returns:

array of source elements. (always 3 elements)

doCommandImpl

protected Result doCommandImpl(TestCase testCase,
                               Runner runner)

Deprecated.

Implementation of command. You can override this method.

Parameters:

testCase - test-case instance.

runner - Runner object.

Returns:

result.

doCommand

public final Result doCommand(TestCase testCase,
                              Runner runner)

Deprecated.

Execute selenese command.

Parameters:

testCase - test-case instatnce.

runner - Runner object.

Returns:

true if command terminated normally.

next

@Deprecated
public Command next(TestCase testCase)

Deprecated.

Get next command.

Parameters:

testCase - test-case instance.

Returns:

next command.

setStartLoop

public void setStartLoop(StartLoop startLoop)

Deprecated.

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()

Deprecated.

Description copied from interface: ICommand

Get beginning-of-loop command.

Specified by:

getStartLoop in interface ICommand

Returns:

beginning-of-loop command.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

mayUpdateScreen

public boolean mayUpdateScreen()

Deprecated.

Description copied from interface: ICommand

May the command update screen?

Specified by:

mayUpdateScreen in interface ICommand

Returns:

true if the command may update screen.

getArguments

public String[] getArguments()

Deprecated.

Description copied from interface: ICommand

Get command arguments.

Specified by:

getArguments in interface ICommand

Returns:

command arguments.

convertLocators

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.

execute

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

Deprecated.

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.

addScreenshot

public void addScreenshot(String path,
                          String label)

Deprecated.

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()

Deprecated.

Description copied from interface: ICommand

Get list of screenshot images.

Specified by:

getScreenshots in interface ICommand

Returns:

list of image path of sreenshot.