com.swath.cmd
Class WaitForEvent

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

All Implemented Interfaces:

CommandIfc

public final class WaitForEvent

extends com.swath.cmd.SwathCommand

Wait for specific event(s).
Prompts: -

Since:

SWATH 1.7

See Also:

WaitForPrompt, UserDefinedEvent, UserDefinedCommand

Method Summary

static EventIfc	exec(java.lang.Class eventClass) Wait for a specific event with no timeout.
static EventIfc	exec(java.lang.Class[] eventClasses) Wait for one of several events with no timeout.
static EventIfc	exec(java.lang.Class[] eventClasses, int timeout) Wait for one of several events or timeout.
static EventIfc	exec(java.lang.Class eventClass, int timeout) Wait for a specific event or timeout.
java.lang.String	getClassName() Gets the command class name.
java.lang.Class[]	getEventClasses() Returns the event classes.
java.lang.String	getName() Gets the name of the command.
java.util.Enumeration	getParams() Gets the command parameters.
UserDefinedEvent[]	getUserEvents() Returns the user events.
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

isInternal

public boolean isInternal()

Description copied from interface: CommandIfc

Indicates if this is an internal SWATH command or not.

initCommand

public boolean initCommand()

getEventClasses

public java.lang.Class[] getEventClasses()

Returns the event classes.
Used by SWATH only!

Returns:

The event classes.

Since:

SWATH 1.7.1

getUserEvents

public UserDefinedEvent[] getUserEvents()

Returns the user events.
Used by SWATH only!

Returns:

The user events.

Since:

SWATH 1.7.1

exec

public static EventIfc exec(java.lang.Class eventClass)
                     throws java.lang.Exception

Wait for a specific event with no timeout.

Parameters:

eventClass - The event class to wait for.

Returns:

The received event.

Throws:

java.lang.Exception

Since:

SWATH 1.7

exec

public static EventIfc exec(java.lang.Class[] eventClasses)
                     throws java.lang.Exception

Wait for one of several events with no timeout. The method will return immediately when a matching event is received.

Parameters:

eventClasses - An array with event classes to wait for.

Returns:

The received event.

Throws:

java.lang.Exception

Since:

SWATH 1.7

exec

public static EventIfc exec(java.lang.Class eventClass,
                            int timeout)
                     throws java.lang.Exception

Wait for a specific event or timeout.

Parameters:

eventClass - The event class to wait for.

timeout - The timeout value in milliseconds.

Returns:

The received event.

Throws:

TimeoutException - If there was a timeout.

java.lang.Exception

Since:

SWATH 1.7

exec

public static EventIfc exec(java.lang.Class[] eventClasses,
                            int timeout)
                     throws java.lang.Exception

Wait for one of several events or timeout. The method will return immediately when a matching event is received.

Parameters:

eventClasses - An array with event classes to wait for.

timeout - The timeout value in milliseconds.

Returns:

The received event.

Throws:

TimeoutException - If there was a timeout.

java.lang.Exception

Since:

SWATH 1.7

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.