com.swath.cmd
Class WaitForPrompt

java.lang.Object
  com.swath.Info
      com.swath.cmd.SwathCommand
          com.swath.cmd.WaitForPrompt

All Implemented Interfaces:

CommandIfc

public final class WaitForPrompt

extends com.swath.cmd.SwathCommand

Wait for specific TW prompt(s).
Prompts: -

Since:

SWATH 1.4

See Also:

WaitForEvent, UserDefinedCommand

Method Summary

static int	exec(int prompts) Wait for specific TW prompt(s) with no timeout.
static int	exec(int prompts, int timeout) Wait for specific TW prompt(s) or timeout.
java.lang.String	getClassName() Gets the command class name.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
boolean	initCommand()
boolean	isInternal() Indicates if this is an internal SWATH command or not.
boolean	isUserDefined() Indicates if this command is user defined or not.

Methods inherited from class java.lang.Object

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

Method Detail

initCommand

public boolean initCommand()

exec

public static int exec(int prompts)
                throws java.lang.Exception

Wait for specific TW prompt(s) with no timeout. The method will return immediately when a matching prompt is reached.

Parameters:

prompts - The prompt(s) to wait for. (Combine several prompts with logic OR: | )

Returns:

The prompt that was reached.

Throws:

java.lang.Exception

Since:

SWATH 1.4

See Also:

Swath.COMMAND_PROMPT, Swath.COMPUTER_PROMPT, Swath.PLANET_PROMPT, Swath.CITADEL_PROMPT, Swath.CORP_PROMPT, Swath.STARDOCK_PROMPT, Swath.ALL_PROMPTS

exec

public static int exec(int prompts,
                       int timeout)
                throws java.lang.Exception

Wait for specific TW prompt(s) or timeout. The method will return immediately when a matching prompt is reached.
NOTE: This function will be moved/removed in the future. It will be replaced by an event model.

Parameters:

prompts - The prompt(s) to wait for. (Combine several prompts with logic OR: | )

timeout - The timeout value in milliseconds.

Returns:

The prompt that was reached.

Throws:

TimeoutException - If there was a timeout.

java.lang.Exception

Since:

SWATH 1.6

See Also:

Swath.NO_PROMPT, Swath.COMMAND_PROMPT, Swath.COMPUTER_PROMPT, Swath.PLANET_PROMPT, Swath.CITADEL_PROMPT, Swath.CORP_PROMPT, Swath.STARDOCK_PROMPT, Swath.ALL_PROMPTS

isUserDefined

public final boolean isUserDefined()

Description copied from interface: CommandIfc

Indicates if this command is user defined or not.

Specified by:

isUserDefined in interface CommandIfc

Returns:

true if user defined, otherwise false.

getName

public final java.lang.String getName()

Description copied from interface: CommandIfc

Gets the name of the command.

Specified by:

getName in interface CommandIfc

Returns:

The command name.

getClassName

public final java.lang.String getClassName()

Description copied from interface: CommandIfc

Gets the command class name.

Specified by:

getClassName in interface CommandIfc

Returns:

The class name.

getParams

public final java.util.Enumeration getParams()

Description copied from interface: CommandIfc

Gets the command parameters.

Specified by:

getParams in interface CommandIfc

Returns:

The command parameters.

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

Specified by:

isInternal in interface CommandIfc

Returns:

true if internal, otherwise false.