com.wrq.vhi.script.api.command
Class WaitForCondition

java.lang.Object
  com.wrq.vhi.script.api.command.Command
      com.wrq.vhi.script.api.command.WaitForCondition

public class WaitForCondition
extends Command

A class that represents a VHI WaitForCondition command.

See Also:

CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.waitForCondition(java.lang.String, java.lang.String, int)

Constructor Summary

WaitForCondition(java.lang.String entity, java.lang.String condition, int timeout)
Constructs a new WaitForCondition command.

Method Summary

java.lang.String	getCondition() Gets the condition.
java.lang.String	getEntity() Gets the entity.
java.lang.String	getName() Gets the command name.
int	getTimeout() Gets the timeout

Methods inherited from class com.wrq.vhi.script.api.command.Command

isValidEchoType

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitForCondition

public WaitForCondition(java.lang.String entity,
                        java.lang.String condition,
                        int timeout)

Constructs a new WaitForCondition command.

Parameters:

entity - the name of the entity to use as the context for the expression.

condition - the expression to wait for

timeout - the maximum time to wait in seconds

Method Detail

getEntity

public java.lang.String getEntity()

Gets the entity.

Returns:

the name of the entity to use as the context for the expression

getCondition

public java.lang.String getCondition()

Gets the condition.

Returns:

the expression to wait for

getTimeout

public int getTimeout()

Gets the timeout

Returns:

the maximum time to wait in seconds

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name