org.pfsw.text

Class RegexPattern

java.lang.Object

org.pfsw.text.AStringFilter

org.pfsw.text.RegexPattern

All Implemented Interfaces:

IObjectFilter<java.lang.String>, IStringFilter

public class RegexPattern
extends AStringFilter

A regular expression pattern that can be used multiple times to be matched against strings. It conforms to interfaces IStringFilter and IObjectFilter.

The supported regex syntax is the same as in java.util.regex package.

Field Summary

Fields inherited from interface org.pfsw.bif.text.IStringFilter

ALL, NONE

Constructor Summary

Constructors

Constructor and Description
RegexPattern(java.lang.String regularExpression) Creates a new pattern based on the given regular expression.

Method Summary

Modifier and Type	Method and Description
protected java.util.regex.Pattern	getPattern()
boolean	matches(java.lang.String aString) Returns true if the given string matches the filter otherwise false.
protected void	setPattern(java.util.regex.Pattern pattern)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexPattern

public RegexPattern(java.lang.String regularExpression)

Creates a new pattern based on the given regular expression.

Parameters:

regularExpression - The regular expression (must not be null).

Throws:

java.lang.IllegalArgumentException - if the given expression is null.

Method Detail

matches

public boolean matches(java.lang.String aString)

Description copied from interface: IStringFilter

Returns true if the given string matches the filter otherwise false.

Parameters:

aString - Any string or even null

getPattern

protected java.util.regex.Pattern getPattern()

setPattern

protected void setPattern(java.util.regex.Pattern pattern)