net.sf.expectit

Interface Expect

All Superinterfaces:

AutoCloseable, Closeable

public interface Expect
extends Closeable

The main interface providing access to the expect operations.

Input data for the operations is stored in the internal buffer growing while new data is being received from the underlying input stream. A successful match operation updates the buffer by removing a part from the begging until the end position of the match.

The send methods are thread safe as long as the underlying output streams are thread safe. In other words it is safe to send data from one thread and expect the results in another.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all resources associated with this instance.
MultiResult	expect(long timeoutMs, Matcher<?>... matcher) Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.
<R extends Result> R	expect(long timeoutMs, Matcher<R> matcher) Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.
MultiResult	expect(Matcher<?>... matchers) Blocks until all the given matchers match against the first input stream using the default timeout.
<R extends Result> R	expect(Matcher<R> matcher) Blocks until the given matcher matches against the first input stream using the default timeout.
MultiResult	expectIn(int input, long timeoutMs, Matcher<?>... matchers) Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.
<R extends Result> R	expectIn(int input, long timeoutMs, Matcher<R> matcher) Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.
<R extends Result> R	expectIn(int input, Matcher<R> matcher) Blocks until the given matcher matches against the given input stream using the default timeout.
InteractBuilder	interact() Starts the interactive loop for the first input.
InteractBuilder	interactWith(int input) Starts the interactive loop for the given input.
Expect	send(String string) Sends the string to the output stream and flushes the output.
Expect	sendBytes(byte[] bytes) Sends the given byte array and flushes the output.
Expect	sendLine() Sends a new line to the output.
Expect	sendLine(String string) Appends the line separator character to the string and calls send(String) method.
Expect	withInfiniteTimeout() Deprecated. use withTimeout(long, TimeUnit) with Long.MAX_VALUE, TimeUnit.DAYS instead.
Expect	withTimeout(long duration, TimeUnit unit) Sets the default timeout in the given unit for the expect operations for the returned instance.

Method Detail

send

Expect send(String string)
     throws IOException

Sends the string to the output stream and flushes the output.

The string is converted to bytes using charset set in the .ExpectBuilder.

Parameters:

string - the string to be sent

Returns:

this

Throws:

IOException - if I/O error occurs

sendLine

Expect sendLine(String string)
         throws IOException

Appends the line separator character to the string and calls send(String) method.

Parameters:

string - the string to be sent

Returns:

this

Throws:

IOException - if I/O error occurs

See Also:

send(String), ExpectBuilder.withLineSeparator(String)

sendLine

Expect sendLine()
         throws IOException

Sends a new line to the output. Simply calls the sendLine(String) method with empty string as a parameter.

Returns:

this

Throws:

IOException - if I/O error occurs

sendBytes

Expect sendBytes(byte[] bytes)
          throws IOException

Sends the given byte array and flushes the output.

Parameters:

bytes - the bytes to be sent

Returns:

this

Throws:

IOException - if I/O error occurs

expect

<R extends Result> R expect(Matcher<R> matcher)
                     throws IOException

Blocks until the given matcher matches against the first input stream using the default timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input steam, the internal buffer is empty and the match operation is not successful.

Type Parameters:

R - the matcher type

Parameters:

matcher - the mather

Returns:

the match result

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expect

MultiResult expect(Matcher<?>... matchers)
            throws IOException

Blocks until all the given matchers match against the first input stream using the default timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input steam, the internal buffer is empty and the match operation is not successful.

Parameters:

matchers - the matchers

Returns:

the match result from all the matchers

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expect

@Deprecated
<R extends Result> R expect(long timeoutMs,
                                        Matcher<R> matcher)
                                 throws IOException

Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.

Blocks until the given matcher matches the first input stream using the given timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input stream, the internal buffer is empty and the match operation is not successful.

Type Parameters:

R - the matcher type

Parameters:

timeoutMs - the timeout for the expect operation in milliseconds, infinite if -1 is passed

matcher - the mather

Returns:

the match result

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expect

@Deprecated
MultiResult expect(long timeoutMs,
                               Matcher<?>... matcher)
                        throws IOException

Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.

Blocks until all the given matchers match the first input stream using the given timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input steam, the internal buffer is empty and the match operation is not successful.

Parameters:

timeoutMs - the timeout for the expect operation in milliseconds, infinite if -1 is passed

matcher - the matchers

Returns:

the match result from all the matchers

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expectIn

<R extends Result> R expectIn(int input,
                              Matcher<R> matcher)
                       throws IOException

Blocks until the given matcher matches against the given input stream using the default timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input steam, the internal buffer is empty and the match operation is not successful.

Type Parameters:

R - the matcher type

Parameters:

input - the index of the input. if the index is outside of the boundaries, a runtime exception will be thrown

matcher - the matcher

Returns:

the match result

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expectIn

@Deprecated
<R extends Result> R expectIn(int input,
                                          long timeoutMs,
                                          Matcher<R> matcher)
                                   throws IOException

Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.

Blocks until the given matcher matches against the given input stream using the given timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

Type Parameters:

R - the matcher type

Parameters:

input - the index of the input. if the index is outside of the boundaries, a runtime exception will be thrown

timeoutMs - the timeout for the expect operation in milliseconds, infinite if -1 is passed

matcher - the mather

Returns:

the match result

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

expectIn

@Deprecated
MultiResult expectIn(int input,
                                 long timeoutMs,
                                 Matcher<?>... matchers)
                          throws IOException

Deprecated. This method is deprecated and will be removed. Use withTimeout(long, java.util.concurrent.TimeUnit) to change the timeout for the expect operation.

Blocks until all the given matchers matche against the given input stream using the given timeout.

The method throws an AssertionError if ExpectBuilder.errorOnTimeout is set. Deprecated.

An instance of EOFException will be thrown if the underlying input steam, the internal buffer is empty and the match operation is not successful.

Parameters:

input - the index of the input. if the index is outside of the boundaries, a runtime exception will be thrown

timeoutMs - the timeout for the expect operation in milliseconds, infinite if -1 is passed

matchers - the matchers

Returns:

the match result from all the matchers

Throws:

ExpectIOException - if the matcher does not match and the the ExpectBuilder.withExceptionOnFailure() flag was set

ClosedByInterruptException - if the thread calling this method has been interrupted

IOException - if an I/O error occurs

withTimeout

Expect withTimeout(long duration,
                   TimeUnit unit)

Sets the default timeout in the given unit for the expect operations for the returned instance. The timeout for this instance will remain unchanged. Both instances, this and the returned one, will share the same configuration except the default timeout value.

Parameters:

duration - the timeout value

unit - the time unit

Returns:

an Expect instance with a new default timeout.

Throws:

IllegalArgumentException - if the timeout <= 0

withInfiniteTimeout

@Deprecated
Expect withInfiniteTimeout()

Deprecated. use withTimeout(long, TimeUnit) with Long.MAX_VALUE, TimeUnit.DAYS instead.

Sets the default timeout to infinity. The timeout for this instance will remain unchanged. Both instances, this and the returned one, will share the same configuration except the default timeout value.

Returns:

an Expect instance with a new default timeout.

close

void close()
    throws IOException

Closes all resources associated with this instance.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if I/O error occurs

interact

InteractBuilder interact()

Starts the interactive loop for the first input.

Returns:

the interact builder.

interactWith

InteractBuilder interactWith(int input)

Starts the interactive loop for the given input.

Parameters:

input - the index of the input stream to use for the interact loop.

Returns:

the interact builder.