Package org.apache.rat.analysis.matchers

Class AbstractHeaderMatcher

java.lang.Object

org.apache.rat.analysis.matchers.AbstractHeaderMatcher

All Implemented Interfaces:

IHeaderMatcher

Direct Known Subclasses:

AbstractMatcherContainer, CopyrightMatcher, NotMatcher, SimpleRegexMatcher, SimpleTextMatcher, SPDXMatcherFactory.Match

public abstract class AbstractHeaderMatcher
extends Object
implements IHeaderMatcher

An abstract class to simplify IHeaderMatcher creation. This class ensures that the id is set.

Nested Class Summary

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

IHeaderMatcher.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHeaderMatcher(String id)	Constructs the IHeaderMatcher with an id value.

Method Summary

Modifier and Type	Method	Description
String	getId()	Get the identifier for this matcher.
String	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, matches, reset

Constructor Details

AbstractHeaderMatcher

protected AbstractHeaderMatcher(String id)

Constructs the IHeaderMatcher with an id value. If id is null then a unique random id is created.

Parameters:

id - the id to use.

Method Details

getId

public String getId()

Description copied from interface: IHeaderMatcher

Get the identifier for this matcher.

All matchers must have unique identifiers

Specified by:

getId in interface IHeaderMatcher

Returns:

the identifier for this matcher.

toString

public String toString()

Overrides:

toString in class Object