org.spdx.compare

Class CompareTemplateOutputHandler

java.lang.Object

org.spdx.compare.CompareTemplateOutputHandler

All Implemented Interfaces:

ILicenseTemplateOutputHandler

public class CompareTemplateOutputHandler
extends Object
implements ILicenseTemplateOutputHandler

Compares the output of a parsed license template to text. The method matches is called after the document is parsed to determine if the text matches.

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
CompareTemplateOutputHandler(String compareText)

Method Summary

Methods

Modifier and Type	Method and Description
void	beginOptional(LicenseTemplateRule rule) Begin optional rule found
void	endOptional(LicenseTemplateRule rule) End optional rule found
boolean	matches()
void	normalText(String text) Normal text found with the template (non-optional and not within a variable rule)
void	optionalText(String text) Text found within an optional text block
protected boolean	textEquivalent(String text) compare the text to the compare text at the current location
void	variableRule(LicenseTemplateRule rule) Variable rule found within the template

Methods inherited from class java.lang.Object

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

Constructor Detail

CompareTemplateOutputHandler

public CompareTemplateOutputHandler(String compareText)

Parameters:

compareText - Text to compare the parsed SPDX license template to

Method Detail

optionalText

public void optionalText(String text)

Description copied from interface: ILicenseTemplateOutputHandler

Text found within an optional text block

Specified by:

optionalText in interface ILicenseTemplateOutputHandler

textEquivalent

protected boolean textEquivalent(String text)

compare the text to the compare text at the current location

Parameters:

text -

Returns:

true if the text is equivalent

normalText

public void normalText(String text)

Description copied from interface: ILicenseTemplateOutputHandler

Normal text found with the template (non-optional and not within a variable rule)

Specified by:

normalText in interface ILicenseTemplateOutputHandler

variableRule

public void variableRule(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

Variable rule found within the template

Specified by:

variableRule in interface ILicenseTemplateOutputHandler

beginOptional

public void beginOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

Begin optional rule found

Specified by:

beginOptional in interface ILicenseTemplateOutputHandler

endOptional

public void endOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

End optional rule found

Specified by:

endOptional in interface ILicenseTemplateOutputHandler

matches

public boolean matches()

Returns: