com.swath.cmd
Class WaitForText

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

All Implemented Interfaces:

CommandIfc

Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.

public final class WaitForText

extends com.swath.cmd.SwathCommand

Wait for specific text(s) from TW.
Prompts: -

Since:

SWATH 1.3

See Also:

WaitForEvent, WaitForPrompt, UserDefinedCommand

Method Summary

static java.lang.String	exec(java.lang.String text) Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.
static java.lang.String	exec(java.lang.String[] texts) Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.
static java.lang.String	exec(java.lang.String[] texts, int timeout) Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.
static java.lang.String	exec(java.lang.String text, int timeout) Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.
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() Deprecated.
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()

Deprecated.

exec

public static java.lang.String exec(java.lang.String text)
                             throws java.lang.Exception

Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.

Wait for a specific text from TW with no timeout.

Parameters:

text - The text to wait for.

Returns:

The complete line when the text is received.

Throws:

java.lang.Exception

Since:

SWATH 1.3

exec

public static java.lang.String exec(java.lang.String[] texts)
                             throws java.lang.Exception

Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.

Wait for one of several texts from TW with no timeout. The method will return immediately when the first match is received.

Parameters:

texts - An array with texts to wait for.

Returns:

The complete line when a matching text is received.

Throws:

java.lang.Exception

Since:

SWATH 1.4

exec

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

Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.

Wait for a specific text from TW or timeout.

Parameters:

text - The text to wait for.

timeout - The timeout value in milliseconds.

Returns:

The complete line when the text is received.

Throws:

TimeoutException - If there was a timeout.

java.lang.Exception

Since:

SWATH 1.6

exec

public static java.lang.String exec(java.lang.String[] texts,
                                    int timeout)
                             throws java.lang.Exception

Deprecated. Create a UserDefinedCommand instead of using this command. If you miss a specific command, please send a mail to support@swath.net and let us know.

Wait for one of several texts from TW or timeout. The method will return immediately when the first match is received.

Parameters:

texts - An array with texts to wait for.

timeout - The timeout value in milliseconds.

Returns:

The complete line when a matching text is received.

Throws:

TimeoutException - If there was a timeout.

java.lang.Exception

Since:

SWATH 1.6

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.