net.sf.expectit.filter

Class Filters

java.lang.Object

net.sf.expectit.filter.Filters

public final class Filters
extends Object

The filter factory.

Author:

Alexey Gavrilov

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	COLORS_PATTERN The regular expression which matches ANSI escape sequences for colors.
static Pattern	NON_PRINTABLE_PATTERN The regular expression which matches non printable characters: [\x00\x08\x0B\x0C\x0E-\x1F].

Method Summary

Modifier and Type	Method and Description
static Filter	chain(Filter... filters) Combines the filters in a filter chain.
static Filter	removeColors() Creates a filter which removes ANSI escape sequences for colors in the input.
static Filter	removeNonPrintable() Creates a filter which removes all the non-printable characters matching NON_PRINTABLE_PATTERN in the input string.
static Filter	replaceInBuffer(Pattern regexp, String replacement) Creates a filter which replaces every substring in the input buffer that matches the given regular expression and replaces it with given replacement.
static Filter	replaceInBuffer(String regexp, String replacement) Equivalent to replaceInBuffer(java.util.regex.Pattern, String) but takes the regular expression as string.
static Filter	replaceInString(Pattern regexp, String replacement) Equivalent to replaceInString(java.util.regex.Pattern, String, int) but takes the regular expression as string and default overlap in 80 characters.
static Filter	replaceInString(Pattern regexp, String replacement, int overlap) Creates a filter which replaces every substring in the input string that matches the given regular expression and replaces it with given replacement.
static Filter	replaceInString(String regexp, String replacement) Equivalent to replaceInString(java.util.regex.Pattern, String) but takes the regular expression as string and default overlap in 80 characters.

Methods inherited from class java.lang.Object

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

Field Detail

COLORS_PATTERN

public static final Pattern COLORS_PATTERN

The regular expression which matches ANSI escape sequences for colors.

NON_PRINTABLE_PATTERN

public static final Pattern NON_PRINTABLE_PATTERN

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

Method Detail

removeNonPrintable

public static Filter removeNonPrintable()

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

Returns:

the filter

replaceInString

public static Filter replaceInString(Pattern regexp,
                                     String replacement,
                                     int overlap)

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

The method just calls String.replaceAll(String, String) for the input string.

Parameters:

regexp - the regular expression

replacement - the string to be substituted for each match

overlap - the number of characters prepended to the matching string from the previous data chunk before match

Returns:

the filter

replaceInString

public static Filter replaceInString(String regexp,
                                     String replacement)

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

Parameters:

regexp - the regular expression

replacement - the string to be substituted for each match

Returns:

the filter

replaceInString

public static Filter replaceInString(Pattern regexp,
                                     String replacement)

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

Parameters:

regexp - the regular expression

replacement - the string to be substituted for each match

Returns:

the filter

removeColors

public static Filter removeColors()

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

Returns:

the filter

replaceInBuffer

public static Filter replaceInBuffer(String regexp,
                                     String replacement)

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

Parameters:

regexp - the regular expression

replacement - the string to be substituted for each match

Returns:

the filter

replaceInBuffer

public static Filter replaceInBuffer(Pattern regexp,
                                     String replacement)

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

The method just calls String.replaceAll(String, String) for the entire buffer contents every time new data arrives,

Parameters:

regexp - the regular expression

replacement - the string to be substituted for each match

Returns:

the filter

chain

public static Filter chain(Filter... filters)

Combines the filters in a filter chain.

The given filters are applied one by one in the order that hey appear in the method argument list.

The string returns by the Filter.beforeAppend(String, StringBuilder) method of one filter is passed a parameter to the next one if it is not null. If it is null, then the beforeAppend won't be called any more and the latest non-null result is appended to the expect internal buffer.

If the return value of the Filter.afterAppend(StringBuilder) method is true, then all the calls of this method on the consequent filters will be suppressed.

Parameters:

filters - the filters, not null

Returns:

the combined filter