net.sf.expectit.filter

Interface Filter

All Known Implementing Classes:

FilterAdapter

public interface Filter

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

Author:

Alexey Gavrilov

Method Summary

Modifier and Type	Method and Description
boolean	afterAppend(StringBuilder buffer) Invoked when the input string has just been appended to the input buffer.
String	beforeAppend(String string, StringBuilder buffer) Invoked when a string read from the input is about to be appended to the input buffer.
boolean	isEnabled() Indicates if the filter is enabled or disabled.
void	setEnabled(boolean enabled) Enables or disables the filter for the input.

Method Detail

beforeAppend

String beforeAppend(String string,
                    StringBuilder buffer)

Invoked when a string read from the input is about to be appended to the input buffer. This string is passed as a parameter to this method, and the return value is actually appended.

Allows to modify the matching input by providing the return value which differs from the given string. The method is invoked on the thread that performs expect operations.

Parameters:

string - a chunk of input data read from the input stream. Can not be null. If the filter works in the Filters.chain(Filter...), then the string is the result of preceding filter

buffer - the reference to the input buffer. Can be used to modify the entire buffer contents.

Returns:

the string to be appended to the input buffers, or null to ignore all the consequent filters in the filter chain.

afterAppend

boolean afterAppend(StringBuilder buffer)

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

The method is invoked on the thread that performs expect operations.

Parameters:

buffer - the reference to the input buffer. Can be used to modify the entire buffer contents.

Returns:

a boolean flag indicating whether the filtering process should be stopped here. true if all the consequent filters must not be executed, or false otherwise.

isEnabled

boolean isEnabled()

Indicates if the filter is enabled or disabled.

Returns:

true if the filter is enabled, or false otherwise.

setEnabled

void setEnabled(boolean enabled)

Enables or disables the filter for the input.

Allows to switch filter on and off while working with the expect instance.

Parameters:

enabled - if true then the filter will be enabled, or false otherwise.