Package org.apache.rat.analysis.matchers

Class NotMatcher

java.lang.Object

org.apache.rat.analysis.matchers.AbstractHeaderMatcher

org.apache.rat.analysis.matchers.NotMatcher

All Implemented Interfaces:

IHeaderMatcher

public class NotMatcher
extends AbstractHeaderMatcher

An IHeaderMatcher that reverses the result of an enclosed matcher.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.rat.analysis.IHeaderMatcher

IHeaderMatcher.Builder, IHeaderMatcher.State

Constructor Summary

Constructors

Constructor	Description
NotMatcher(String id, IHeaderMatcher enclosed)	Create the matcher with the enclosed matcher and id.
NotMatcher(IHeaderMatcher enclosed)	Create the matcher with the enclosed matcher.

Method Summary

Modifier and Type	Method	Description
IHeaderMatcher.State	currentState()	Gets the the current state of the matcher.
IHeaderMatcher.State	finalizeState()	Gets the final state for this matcher.
IHeaderMatcher.State	matches(String line)	Attempts to match line and returns the State after the match is attempted.
void	reset()	Resets this state State.i.

Methods inherited from class org.apache.rat.analysis.matchers.AbstractHeaderMatcher

getId, toString

Methods inherited from class java.lang.Object

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

Constructor Details

NotMatcher

public NotMatcher(IHeaderMatcher enclosed)

Create the matcher with the enclosed matcher.

Parameters:

enclosed - the enclosed matcher

NotMatcher

public NotMatcher(String id,
 IHeaderMatcher enclosed)

Create the matcher with the enclosed matcher and id.

Parameters:

id - the id for this matcher.

enclosed - the enclosed matcher

Method Details

matches

public IHeaderMatcher.State matches(String line)

Description copied from interface: IHeaderMatcher

Attempts to match line and returns the State after the match is attempted.

Parameters:

line - next line of text, not null

Returns:

the new state after the matching was attempted.

reset

public void reset()

Description copied from interface: IHeaderMatcher

Resets this state State.i. If text is being cached this method should clear that cache.

finalizeState

public IHeaderMatcher.State finalizeState()

Description copied from interface: IHeaderMatcher

Gets the final state for this matcher. This is called after the EOF on the input. At this point there should be no matchers in an State.i state.

currentState

public IHeaderMatcher.State currentState()

Description copied from interface: IHeaderMatcher

Gets the the current state of the matcher. All matchers should be in State.i at the start.

Returns:

the current state of the matcher.