Package org.apache.rat.analysis.matchers

Class SPDXMatcherFactory.Match

java.lang.Object

org.apache.rat.analysis.matchers.AbstractHeaderMatcher

org.apache.rat.analysis.matchers.SPDXMatcherFactory.Match

All Implemented Interfaces:

IHeaderMatcher

Enclosing class:

SPDXMatcherFactory

public class SPDXMatcherFactory.Match
extends AbstractHeaderMatcher

Matches an SPDX identifier.

Nested Class Summary

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

IHeaderMatcher.Builder

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name of this matcher.
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

Method Details

getName

public String getName()

Gets the name of this matcher. Same as the SPDX identifier.

Returns:

name of this matcher, that equals the SPDX identifier.

matches

public 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.