Package org.spdx.utility.compare

Class CompareTemplateOutputHandler

java.lang.Object

org.spdx.utility.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CompareTemplateOutputHandler.DifferenceDescription

Constructor Summary

Constructors

Constructor	Description
CompareTemplateOutputHandler(String compareText)

Method Summary

Modifier and Type	Method	Description
void	beginOptional(LicenseTemplateRule rule)	Begin optional rule found
void	completeParsing()	Signals all text has been added and parsing can be completed.
void	endOptional(LicenseTemplateRule rule)	End optional rule found
CompareTemplateOutputHandler.DifferenceDescription	getDifferences()
boolean	matches()	Performs the actual parsing if it has not been completed.
void	text(String text)	Text for processing
int	textEquivalent(String text, int startToken)	Compares the text against the compareText
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 Details

CompareTemplateOutputHandler

public CompareTemplateOutputHandler(String compareText)
                             throws IOException

Parameters:

compareText - Text to compare the parsed SPDX license template to

Throws:

IOException - This is not to be expected since we are using StringReaders

Method Details

text

public void text(String text)

Description copied from interface: ILicenseTemplateOutputHandler

Text for processing

Specified by:

text 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()
                throws LicenseParserException

Performs the actual parsing if it has not been completed. NOTE: This should only be called after all text has been added.

Returns:

true if no differences were found

Throws:

LicenseParserException

getDifferences

public CompareTemplateOutputHandler.DifferenceDescription getDifferences()

Returns:

details on the differences found

completeParsing

public void completeParsing()
                     throws LicenseParserException

Description copied from interface: ILicenseTemplateOutputHandler

Signals all text has been added and parsing can be completed.

Specified by:

completeParsing in interface ILicenseTemplateOutputHandler

Throws:

LicenseParserException

textEquivalent

public int textEquivalent(String text,
 int startToken)

Compares the text against the compareText

Parameters:

text - text to compare

startToken - token of the compareText to being the comparison

Returns:

next token index (positive) if there is a match, negative first token where this is a miss-match if no match