de.susebox.jtopas.impl

Class PatternMatcher

java.lang.Object

de.susebox.jtopas.impl.PatternMatcher

All Implemented Interfaces:

PatternHandler

public class PatternMatcher
extends java.lang.Object
implements PatternHandler

Implementation of the PatternHandler interface using the JDK 1.4 package java.util.regex.

Author:

Heiko Blau

Nested Class Summary

Nested classes/interfaces inherited from interface de.susebox.jtopas.spi.PatternHandler

PatternHandler.Result

Constructor Summary

Constructors

Constructor and Description
PatternMatcher(TokenizerProperty prop, int globalFlags) The constructor takes a pattern and the TokenizerProperty object associated with this instance of PatternMatcher.

Method Summary

Modifier and Type	Method and Description
TokenizerProperty	getProperty() Retrieving the TokenizerProperty of this PatternMatcher.
boolean	hasPattern() The method is a dummy implementation for the interface PatternHandler and always returns true.
PatternHandler.Result	matches(DataProvider dataProvider) This method checks if the start of a character range given through the DataProvider matches a pattern.
void	setProperty(TokenizerProperty prop) Setting the TokenizerProperty for this PatternMatcher.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternMatcher

public PatternMatcher(TokenizerProperty prop,
                      int globalFlags)
               throws java.lang.NullPointerException

The constructor takes a pattern and the TokenizerProperty object associated with this instance of PatternMatcher. The global flags are passed to control the behaviour for attributes that are not specified in the property itself (e.g. case-sensitivity).

Parameters:

prop - the TokenizerProperty associated with this object

globalFlags - flags that are to be used if not set explicitely in the property

Throws:

java.lang.NullPointerException - if the given parameter is null

Method Detail

hasPattern

public boolean hasPattern()

The method is a dummy implementation for the interface PatternHandler and always returns true.

Specified by:

hasPattern in interface PatternHandler

Returns:

always true

matches

public PatternHandler.Result matches(DataProvider dataProvider)
                              throws TokenizerException,
                                     java.lang.NullPointerException

This method checks if the start of a character range given through the DataProvider matches a pattern. See PatternHandler.matches(de.susebox.jtopas.spi.DataProvider) for details.

Specified by:

matches in interface PatternHandler

Parameters:

dataProvider - the source to get the data from

freePatternOnly - if true only unbounded pattern should be checked (pattern not enclosed in whitespaces, separators etc.)

Returns:

a PatternHandler.Result object or null if no match was found

Throws:

TokenizerException - generic exception

java.lang.NullPointerException - if no DataProvider is given

setProperty

public void setProperty(TokenizerProperty prop)
                 throws java.lang.NullPointerException

Setting the TokenizerProperty for this PatternMatcher. This method will recompile the regular expression pattern.

Parameters:

prop - the TokenizerProperty associated with this object

Throws:

java.lang.NullPointerException - if the given parameter is null

getProperty

public TokenizerProperty getProperty()

Retrieving the TokenizerProperty of this PatternMatcher.

Returns:

the TokenizerProperty associated with this object