A B C D E F G I M N O R S T U W

A

Action<R extends Result> - Interface in net.sf.expectit.interact

The interact loop callback.

adapt(Appendable) - Static method in class net.sf.expectit.echo.EchoAdapters

Deprecated.

afterAppend(StringBuilder) - Method in interface net.sf.expectit.filter.Filter

Invoked when the input string has just been appended to the input buffer.

afterAppend(StringBuilder) - Method in class net.sf.expectit.filter.FilterAdapter

allOf(Matcher<?>...) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches if the examined input matches all of the specified matchers.

anyOf(Matcher<?>...) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches if the examined input matches any of the specified matchers.

anyString() - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches when at least one character exists in the input buffer.

apply(R) - Method in interface net.sf.expectit.interact.Action

The method is called when the interact condition matches.

B

beforeAppend(String, StringBuilder) - Method in interface net.sf.expectit.filter.Filter

Invoked when a string read from the input is about to be appended to the input buffer.

beforeAppend(String, StringBuilder) - Method in class net.sf.expectit.filter.FilterAdapter

build() - Method in class net.sf.expectit.ExpectBuilder

Creates a ready to use Expect instance.

C

canStopMatching() - Method in class net.sf.expectit.matcher.SimpleResult

canStopMatching() - Method in interface net.sf.expectit.Result

Indicates that the matching operation won't have a different result at any point in the future and there is no need to wait for the successful match.

chain(Filter...) - Static method in class net.sf.expectit.filter.Filters

Combines the filters in a filter chain.

close() - Method in interface net.sf.expectit.Expect

Closes all resources associated with this instance.

COLORS_PATTERN - Static variable in class net.sf.expectit.filter.Filters

The regular expression which matches ANSI escape sequences for colors.

contains(String) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher of String that matches when examined input contains the given substring.

D

DEFAULT_BUFFER_SIZE - Static variable in class net.sf.expectit.ExpectBuilder

The default buffer size in bytes.

DEFAULT_TIMEOUT_MS - Static variable in class net.sf.expectit.ExpectBuilder

The default timeout value of 30000 milliseconds.

doAfterAppend(StringBuilder) - Method in class net.sf.expectit.filter.FilterAdapter

Called if the filter is enabled.

doBeforeAppend(String, StringBuilder) - Method in class net.sf.expectit.filter.FilterAdapter

Called if the filter is enabled.

E

EchoAdapters - Class in net.sf.expectit.echo

Deprecated.

EchoOutput - Interface in net.sf.expectit.echo

Deprecated.

end() - Method in class net.sf.expectit.matcher.SimpleResult

end(int) - Method in class net.sf.expectit.matcher.SimpleResult

eof() - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches if input reaches the end of stream.

exact(String) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches when the given string is equal to the input buffer contents.

Expect - Interface in net.sf.expectit

The main interface providing access to the expect operations.

expect(Matcher<R>) - Method in interface net.sf.expectit.Expect

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

expect(Matcher<?>...) - Method in interface net.sf.expectit.Expect

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

expect(long, Matcher<R>) - Method in interface net.sf.expectit.Expect

Deprecated.

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

expect(long, Matcher<?>...) - Method in interface net.sf.expectit.Expect

Deprecated.

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

ExpectBuilder - Class in net.sf.expectit

A class used to construct Expect instances.

ExpectBuilder() - Constructor for class net.sf.expectit.ExpectBuilder

Default constructor.

expectIn(int, Matcher<R>) - Method in interface net.sf.expectit.Expect

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

expectIn(int, long, Matcher<R>) - Method in interface net.sf.expectit.Expect

Deprecated.

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

expectIn(int, long, Matcher<?>...) - Method in interface net.sf.expectit.Expect

Deprecated.

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

ExpectIOException - Exception in net.sf.expectit

An exception which occurs if an expect operation has failed.

ExpectIOException(String, String) - Constructor for exception net.sf.expectit.ExpectIOException

Creates a new exception instance with the given error message.

F

failure(String, boolean) - Static method in class net.sf.expectit.matcher.SimpleResult

Creates an instance of an unsuccessful match.

Filter - Interface in net.sf.expectit.filter

A filter interface applied to the input before performing expect operations.

FilterAdapter - Class in net.sf.expectit.filter

A default filter implementation which does not modify the input.

FilterAdapter() - Constructor for class net.sf.expectit.filter.FilterAdapter

The protected default constructor.

Filters - Class in net.sf.expectit.filter

The filter factory.

G

getBefore() - Method in class net.sf.expectit.matcher.SimpleResult

getBefore() - Method in interface net.sf.expectit.Result

Returns a part of the input string from the beginning until the starting position of the match.

getInput() - Method in class net.sf.expectit.matcher.SimpleResult

getInput() - Method in interface net.sf.expectit.Result

Gets latest input string passed to the matcher before it returns.

getInputBuffer() - Method in exception net.sf.expectit.ExpectIOException

Retrieves the input data buffer when the exception occurs.

getResults() - Method in interface net.sf.expectit.MultiResult

Returns an unmodifiable list of the result instances of all the performed match operations .

group() - Method in class net.sf.expectit.matcher.SimpleResult

group(int) - Method in class net.sf.expectit.matcher.SimpleResult

groupCount() - Method in class net.sf.expectit.matcher.SimpleResult

I

interact() - Method in interface net.sf.expectit.Expect

Starts the interactive loop for the first input.

InteractBuilder - Interface in net.sf.expectit.interact

The interactive loop builder.

interactWith(int) - Method in interface net.sf.expectit.Expect

Starts the interactive loop for the given input.

isEnabled() - Method in interface net.sf.expectit.filter.Filter

Indicates if the filter is enabled or disabled.

isEnabled() - Method in class net.sf.expectit.filter.FilterAdapter

isSuccessful() - Method in class net.sf.expectit.matcher.SimpleResult

isSuccessful() - Method in interface net.sf.expectit.Result

Indicates whether the match was successful or not.

M

Matcher<R extends Result> - Interface in net.sf.expectit.matcher

A matcher for expect operations.

Matchers - Class in net.sf.expectit.matcher

The matcher factory.

matches(String, boolean) - Method in interface net.sf.expectit.matcher.Matcher

Matches the input string.

matches(String) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher of String that matches when examined input fully matches the given regular expression.

matches(Pattern) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher of Pattern that matches when examined input fully matches the given regular expression.

MultiResult - Interface in net.sf.expectit

A representation of the result of multiple match operations.

N

net.sf.expectit - package net.sf.expectit

Classes for implementing expect-like functionality.

net.sf.expectit.echo - package net.sf.expectit.echo

Classes for echo data processed by the Expect implementtion.

net.sf.expectit.filter - package net.sf.expectit.filter

Classes for filtering input before passing it further for matching.

net.sf.expectit.interact - package net.sf.expectit.interact

Classes for interact operation support.

net.sf.expectit.matcher - package net.sf.expectit.matcher

Classes for different types of match operations.

NON_PRINTABLE_PATTERN - Static variable in class net.sf.expectit.filter.Filters

The regular expression which matches non printable characters: [\x00\x08\x0B\x0C\x0E-\x1F].

O

OngoingResult<R extends Result> - Interface in net.sf.expectit.interact

The interact result builder.

onReceive(int, String) - Method in interface net.sf.expectit.echo.EchoOutput

Deprecated.

A callback method called when the data is received from the given input.

onSend(String) - Method in interface net.sf.expectit.echo.EchoOutput

Deprecated.

A callback method called when the data has just been sent to the output.

R

regexp(String) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher of String that matches when examined input contains the given regular expression.

regexp(Pattern) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher of Pattern that matches when examined input contains the given regular expression.

removeColors() - Static method in class net.sf.expectit.filter.Filters

Creates a filter which removes ANSI escape sequences for colors in the input.

removeNonPrintable() - Static method in class net.sf.expectit.filter.Filters

Creates a filter which removes all the non-printable characters matching Filters.NON_PRINTABLE_PATTERN in the input string.

replaceInBuffer(String, String) - Static method in class net.sf.expectit.filter.Filters

Equivalent to Filters.replaceInBuffer(java.util.regex.Pattern, String) but takes the regular expression as string.

replaceInBuffer(Pattern, String) - Static method in class net.sf.expectit.filter.Filters

Creates a filter which replaces every substring in the input buffer that matches the given regular expression and replaces it with given replacement.

replaceInString(Pattern, String, int) - Static method in class net.sf.expectit.filter.Filters

Creates a filter which replaces every substring in the input string that matches the given regular expression and replaces it with given replacement.

replaceInString(String, String) - Static method in class net.sf.expectit.filter.Filters

Equivalent to Filters.replaceInString(java.util.regex.Pattern, String) but takes the regular expression as string and default overlap in 80 characters.

replaceInString(Pattern, String) - Static method in class net.sf.expectit.filter.Filters

Equivalent to Filters.replaceInString(java.util.regex.Pattern, String, int) but takes the regular expression as string and default overlap in 80 characters.

Result - Interface in net.sf.expectit

A representation of the result of a single match operation.

S

send(String) - Method in interface net.sf.expectit.Expect

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

sendBytes(byte[]) - Method in interface net.sf.expectit.Expect

Sends the given byte array and flushes the output.

sendLine(String) - Method in interface net.sf.expectit.Expect

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

sendLine() - Method in interface net.sf.expectit.Expect

Sends a new line to the output.

sequence(Matcher<?>...) - Static method in class net.sf.expectit.matcher.Matchers

Matches the given matchers one by one.

setEnabled(boolean) - Method in interface net.sf.expectit.filter.Filter

Enables or disables the filter for the input.

setEnabled(boolean) - Method in class net.sf.expectit.filter.FilterAdapter

SimpleResult - Class in net.sf.expectit.matcher

A result of string matching.

SimpleResult(boolean, String, String, String, boolean) - Constructor for class net.sf.expectit.matcher.SimpleResult

Creates an instance with the initial field values.

start() - Method in class net.sf.expectit.matcher.SimpleResult

start(int) - Method in class net.sf.expectit.matcher.SimpleResult

startsWith(String) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches when the input buffer starts with the given string.

success(String, String, String) - Static method in class net.sf.expectit.matcher.SimpleResult

Creates an instance of a successful result type.

T

then(Action<R>) - Method in interface net.sf.expectit.interact.OngoingResult

Sets the action if the interact matcher matches.

times(int, Matcher<?>) - Static method in class net.sf.expectit.matcher.Matchers

Creates a matcher that matches if the given matcher matches the number of times.

toString() - Method in class net.sf.expectit.matcher.SimpleResult

U

until(Matcher<R>) - Method in interface net.sf.expectit.interact.InteractBuilder

Enters the interact loop and sets the matching predicate for the exit condition.

W

when(Matcher<R>) - Method in interface net.sf.expectit.interact.InteractBuilder

Sets the matching predicate for the action condition.

withAutoFlushEcho(boolean) - Method in class net.sf.expectit.ExpectBuilder

Enables automatic flushing of the echo input and output after each match operation if the given echo object(s) implements Flushable interface.

withBufferSize(int) - Method in class net.sf.expectit.ExpectBuilder

Sets the size of the input buffer in bytes.

withCharset(Charset) - Method in class net.sf.expectit.ExpectBuilder

Sets the character encoding used to covert bytes when working with byte streams.

withCombineInputs(boolean) - Method in class net.sf.expectit.ExpectBuilder

Combines input streaming data into one input.

withEchoInput(Appendable, Appendable...) - Method in class net.sf.expectit.ExpectBuilder

Enables printing of all the received data.

withEchoOutput(EchoOutput) - Method in class net.sf.expectit.ExpectBuilder

Deprecated.

withEchoOutput(Appendable) - Method in class net.sf.expectit.ExpectBuilder

Enables printing of all the sent data.

withErrorOnTimeout(boolean) - Method in class net.sf.expectit.ExpectBuilder

Deprecated.

This method is deprecated and will be removed. Use ExpectBuilder.withExceptionOnFailure() instead.

withExceptionOnFailure() - Method in class net.sf.expectit.ExpectBuilder

Enables throwing an ExpectIOException if an expect operation was not successful.

withExecutor(ExecutorService) - Method in class net.sf.expectit.ExpectBuilder

Set the executor used to create internal thread.

withInfiniteTimeout() - Method in interface net.sf.expectit.Expect

Deprecated.

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

withInfiniteTimeout() - Method in class net.sf.expectit.ExpectBuilder

Sets the default timeout to infinity.

withInputFilters(Filter, Filter...) - Method in class net.sf.expectit.ExpectBuilder

Sets a filter for the input.

withInputs(InputStream...) - Method in class net.sf.expectit.ExpectBuilder

Sets the input streams for expect operations.

withLineSeparator(String) - Method in class net.sf.expectit.ExpectBuilder

Sets the line separator used by the Expect.sendLine() method.

withOutput(OutputStream) - Method in class net.sf.expectit.ExpectBuilder

Sets the output stream where Expect sends command to.

withTimeout(long, TimeUnit) - Method in interface net.sf.expectit.Expect

Sets the default timeout in the given unit for the expect operations for the returned instance.

withTimeout(long, TimeUnit) - Method in class net.sf.expectit.ExpectBuilder

Sets the default timeout in the given unit for expect operations.

A B C D E F G I M N O R S T U W