Package org.apache.rat.document.impl

Class TraceableDocumentNameMatcher

java.lang.Object

org.apache.rat.document.impl.TraceableDocumentNameMatcher

All Implemented Interfaces:

DocumentNameMatcher

public class TraceableDocumentNameMatcher
extends Object
implements DocumentNameMatcher

A PatternMatcher that will emit trace messages during execution if the environment variable is set. Also provides a printable name for general logging.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENV_VAR	The environment variable to set to enable tracing for the PatternMatcher execution
static final TraceableDocumentNameMatcher	FALSE	A TraceableDocumentNameMatcher that always returns false
protected final Supplier<String>	name	The supplier for the name
static final TraceableDocumentNameMatcher	TRUE	A TraceableDocumentNameMatcher that always returns true

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TraceableDocumentNameMatcher(Supplier<String> name, DocumentNameMatcher delegate)	Creates a traceable pattern matcher with the specified name.

Method Summary

Modifier and Type	Method	Description
static TraceableDocumentNameMatcher	and(TraceableDocumentNameMatcher... matchers)	Performs a logical "AND" across the collection of matchers.
static TraceableDocumentNameMatcher	from(FileFilter fileFilter)
static TraceableDocumentNameMatcher	make(Supplier<String> name, DocumentNameMatcher delegate)	Creates a TraceableDocumentNameMatcher from a PathMatcher.
boolean	matches(DocumentName documentName)
static TraceableDocumentNameMatcher	not(TraceableDocumentNameMatcher nameMatcher)	Performs a logical "not" on a nameMatcher.
static TraceableDocumentNameMatcher	or(Collection<TraceableDocumentNameMatcher> matchers)	Performs a logical "OR" across the collection of matchers.
static TraceableDocumentNameMatcher	or(TraceableDocumentNameMatcher... matchers)	Performs a logical "OR" across the collection of matchers.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ENV_VAR

public static final String ENV_VAR

The environment variable to set to enable tracing for the PatternMatcher execution

name

protected final Supplier<String> name

The supplier for the name

TRUE

public static final TraceableDocumentNameMatcher TRUE

A TraceableDocumentNameMatcher that always returns true

FALSE

public static final TraceableDocumentNameMatcher FALSE

A TraceableDocumentNameMatcher that always returns false

Constructor Details

TraceableDocumentNameMatcher

protected TraceableDocumentNameMatcher(Supplier<String> name,
 DocumentNameMatcher delegate)

Creates a traceable pattern matcher with the specified name.

Parameters:

name - the name of the pattern matcher.

delegate - the delegate that actually does the work.

Method Details

make

public static TraceableDocumentNameMatcher make(Supplier<String> name,
 DocumentNameMatcher delegate)

Creates a TraceableDocumentNameMatcher from a PathMatcher. If the delegate is already a TraceableDocumentNameMatcher it will be returned unmodified.

Parameters:

name - the name of the traceable path matcher.

delegate - the PathMatcher that will actually do the work.

Returns:

the new TraceableDocumentNameMatcher

from

public static TraceableDocumentNameMatcher from(FileFilter fileFilter)

not

public static TraceableDocumentNameMatcher not(TraceableDocumentNameMatcher nameMatcher)

Performs a logical "not" on a nameMatcher.

Parameters:

nameMatcher - the matcher to negate.

Returns:

a PathMatcher that is the negation of the argument.

or

public static TraceableDocumentNameMatcher or(Collection<TraceableDocumentNameMatcher> matchers)

Performs a logical "OR" across the collection of matchers.

Parameters:

matchers - the matchers to check.

Returns:

a matcher that returns TRUE if any of the enclosed matchers returns true.

or

public static TraceableDocumentNameMatcher or(TraceableDocumentNameMatcher... matchers)

Performs a logical "OR" across the collection of matchers.

Parameters:

matchers - the matchers to check.

Returns:

a matcher that returns TRUE if any of the enclosed matchers returns true.

and

public static TraceableDocumentNameMatcher and(TraceableDocumentNameMatcher... matchers)

Performs a logical "AND" across the collection of matchers.

Parameters:

matchers - the matchers to check.

Returns:

a matcher that returns TRUE if all the enclosed matchers return true.

toString

public String toString()

Overrides:

toString in class Object

matches

public boolean matches(DocumentName documentName)

Specified by:

matches in interface DocumentNameMatcher