Package org.apache.rat.testhelpers

Class TestingMatcher

java.lang.Object

org.apache.rat.analysis.matchers.AbstractHeaderMatcher

org.apache.rat.testhelpers.TestingMatcher

All Implemented Interfaces:

IHeaderMatcher

public class TestingMatcher
extends AbstractHeaderMatcher

A matcher for testing.

Nested Class Summary

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

IHeaderMatcher.Builder

Constructor Summary

Constructors

Constructor	Description
TestingMatcher()	Constructs a matcher with an id of "dfltMtch" that does not match anything.
TestingMatcher(boolean result)	Constructs a matcher with the specified id and matching result.
TestingMatcher(String id, boolean result)	Constructs a matcher with the specified id and matching result.
TestingMatcher(String id, boolean... results)	Constructs a matcher with the specified id that returns the matching values in order.

Method Summary

Modifier and Type	Method	Description
final boolean	matches(IHeaders headers)	Attempts to match text in the IHeaders instance.
void	reset()	Resets this state of this matcher to its initial state in preparation for use with another document scan.

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

Methods inherited from interface org.apache.rat.analysis.IHeaderMatcher

getDescription

Constructor Details

TestingMatcher

public TestingMatcher()

Constructs a matcher with an id of "dfltMtch" that does not match anything.

TestingMatcher

public TestingMatcher(boolean result)

Constructs a matcher with the specified id and matching result.

Parameters:

result - if true will match everything, otherwise it matches nothing.

TestingMatcher

public TestingMatcher(String id,
 boolean result)

Constructs a matcher with the specified id and matching result.

Parameters:

id - the id for this matcher.

result - if true will match everything, otherwise it matches nothing.

TestingMatcher

public TestingMatcher(String id,
 boolean... results)

Constructs a matcher with the specified id that returns the matching values in order. Will throw NullPointerException if more matches() are called than there are results.

Parameters:

id - the id of the matcher.

results - the result for each call to match.

Method Details

matches

public final boolean matches(IHeaders headers)

Description copied from interface: IHeaderMatcher

Attempts to match text in the IHeaders instance.

Parameters:

headers - the representations of the headers to check

Returns:

true if the matcher matches the text, false otherwise.

reset

public void reset()

Description copied from interface: IHeaderMatcher

Resets this state of this matcher to its initial state in preparation for use with another document scan. In most cases this method does not need to do anything.