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

java.lang.Object
  extended by com.wrq.vhi.script.api.command.Command
      extended by com.wrq.vhi.script.api.command.WaitForCommString

public class WaitForCommString
extends Command

A class that represents a VHI WaitForCommString command.

See Also:
CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.waitForCommString(java.lang.String, int)

Constructor Summary
WaitForCommString(java.lang.String text, int timeout, int count)
          Constructs a new WaitForCommString command.
 
Method Summary
 int getCount()
          Gets the count.
 java.lang.String getName()
          Gets the command name.
 java.lang.String getText()
          Gets the text.
 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

WaitForCommString

public WaitForCommString(java.lang.String text,
                         int timeout,
                         int count)
Constructs a new WaitForCommString command.

Parameters:
text - the string to wait for
timeout - the maximum time to wait in seconds
count - the number of times the string must be found
Method Detail

getText

public java.lang.String getText()
Gets the text.

Returns:
the string to wait for

getTimeout

public int getTimeout()
Gets the timeout.

Returns:
the maximum time to wait in seconds

getCount

public int getCount()
Gets the count.

Returns:
the number of times the string must be found

getName

public java.lang.String getName()
Gets the command name.

Specified by:
getName in class Command
Returns:
the command name