com.waveset.adapter.ScriptedConnection
Class ScriptToken.WaitFor

java.lang.Object
  extended bycom.waveset.adapter.ScriptedConnection.ScriptToken
      extended bycom.waveset.adapter.ScriptedConnection.ScriptToken.WaitFor
Enclosing class:
ScriptToken

public static class ScriptToken.WaitFor
extends ScriptToken

Waits for and consumes up to a string in the input. Optionally can cause an error if a rejected string is found first.


Nested Class Summary
 
Nested classes inherited from class com.waveset.adapter.ScriptedConnection.ScriptToken
ScriptToken.Capture, ScriptToken.Send, ScriptToken.SendPassword, ScriptToken.Sleep, ScriptToken.Timeout, ScriptToken.WaitFor, ScriptToken.WaitForIgnoreCase
 
Field Summary
 
Fields inherited from class com.waveset.adapter.ScriptedConnection.ScriptToken
CAPTURE_TIMEOUT, CLASS, code_id, DEFAULT_TIMEOUT, DEFAULT_TIMEOUT_PROPERTY, RESOURCE_POLICY_GLOBAL_SCOPE, SCRIPTTOKEN_TIMEOUT, WAITFOR_TIMEOUT, WAITFORIGNORECASE_TIMEOUT
 
Constructor Summary
ScriptToken.WaitFor(java.lang.String value)
          Constructor takes the string to wait for.
ScriptToken.WaitFor(java.lang.String value, int timeout)
          Constructor takes the string to wait for.
ScriptToken.WaitFor(java.lang.String value, java.lang.String reject)
          Constructor takes the string to wait for and any reject strings to error out on.
ScriptToken.WaitFor(java.lang.String value, java.lang.String[] reject)
          Constructor takes the string to wait for and any reject strings to error out on.
ScriptToken.WaitFor(java.lang.String value, java.lang.String[] reject, int timeout)
          Constructor takes the string to wait for and any reject strings to error out on.
ScriptToken.WaitFor(java.lang.String value, java.lang.String reject, int timeout)
           
 
Method Summary
 java.lang.String[] getAllRejects()
          Returns the | delimited reject strings or null if there are none.
 java.lang.String getRejects()
          Returns the | delimited reject strings or null if there are none.
 boolean hasReject()
          Returns true if the token has any reject strings.
 boolean includesReject(java.lang.String s)
           
 java.lang.String toString()
          Makes a string of this.
 
Methods inherited from class com.waveset.adapter.ScriptedConnection.ScriptToken
getTimeout, getValue, isTimeoutSpecified, setTimeout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value)
Constructor takes the string to wait for. Will not look for any reject string.


ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value,
                           int timeout)
Constructor takes the string to wait for. Will not look for any reject string and will timeout in the specfied number of miliseconds. The default value is specified by the DEFAULT_TIMEOUT define above.


ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value,
                           java.lang.String[] reject)
Constructor takes the string to wait for and any reject strings to error out on.


ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value,
                           java.lang.String reject)
Constructor takes the string to wait for and any reject strings to error out on.


ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value,
                           java.lang.String reject,
                           int timeout)

ScriptToken.WaitFor

public ScriptToken.WaitFor(java.lang.String value,
                           java.lang.String[] reject,
                           int timeout)
Constructor takes the string to wait for and any reject strings to error out on. Wait for the number of specfied miliseconds. The default value is 10000 milliseconds. ( 10 seconds )

Method Detail

getRejects

public java.lang.String getRejects()
Returns the | delimited reject strings or null if there are none.


getAllRejects

public java.lang.String[] getAllRejects()
Returns the | delimited reject strings or null if there are none.


hasReject

public boolean hasReject()
Returns true if the token has any reject strings.


toString

public java.lang.String toString()
Makes a string of this.

Overrides:
toString in class ScriptToken

includesReject

public boolean includesReject(java.lang.String s)