net.sf.expectit.filter

Class FilterAdapter

java.lang.Object

net.sf.expectit.filter.FilterAdapter

All Implemented Interfaces:

Filter

public class FilterAdapter
extends Object
implements Filter

A default filter implementation which does not modify the input.

Implements functionality for enable/disable the filter. It is intended to be used for creating subclasses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterAdapter() The protected default constructor.

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.
protected boolean	doAfterAppend(StringBuilder buffer) Called if the filter is enabled.
protected String	doBeforeAppend(String string, StringBuilder buffer) Called if the filter is enabled.
boolean	isEnabled() Indicates if the filter is enabled or disabled.
void	setEnabled(boolean enabled) Enables or disables the filter for the input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterAdapter

protected FilterAdapter()

The protected default constructor.

Method Detail

beforeAppend

public final String beforeAppend(String string,
                                 StringBuilder buffer)

Description copied from interface: Filter

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.

Specified by:

beforeAppend in interface Filter

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.

doBeforeAppend

protected String doBeforeAppend(String string,
                                StringBuilder buffer)

Called if the filter is enabled. Follows the contract of the beforeAppend(String, StringBuilder) method.

By default returns the given string.

Parameters:

string - the input string

buffer - the input buffer

Returns:

the result

afterAppend

public final boolean afterAppend(StringBuilder buffer)

Description copied from interface: Filter

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

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

Specified by:

afterAppend in interface Filter

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.

doAfterAppend

protected boolean doAfterAppend(StringBuilder buffer)

Called if the filter is enabled. Follows the contract of the (StringBuilder) method.

Parameters:

buffer - the input buffer

Returns:

the result, the default implementation returns false.

isEnabled

public final boolean isEnabled()

Description copied from interface: Filter

Indicates if the filter is enabled or disabled.

Specified by:

isEnabled in interface Filter

Returns:

true if the filter is enabled, or false otherwise.

setEnabled

public final void setEnabled(boolean enabled)

Description copied from interface: Filter

Enables or disables the filter for the input.

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

Specified by:

setEnabled in interface Filter

Parameters:

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