Package org.spdx.utility.compare

Class FilterTemplateOutputHandler

java.lang.Object

org.spdx.utility.compare.FilterTemplateOutputHandler

All Implemented Interfaces:

ILicenseTemplateOutputHandler

public class FilterTemplateOutputHandler
extends Object
implements ILicenseTemplateOutputHandler

Filter the template output to create a list of strings filtering out optional and/or var text

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilterTemplateOutputHandler.VarTextHandling

Field Summary

Fields

Modifier and Type	Field	Description
static String	REGEX_ESCAPE

Constructor Summary

Constructors

Constructor	Description
FilterTemplateOutputHandler(boolean includeVarText)	Deprecated.
FilterTemplateOutputHandler(FilterTemplateOutputHandler.VarTextHandling varTextHandling)

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
List<String>	getFilteredText()
FilterTemplateOutputHandler.VarTextHandling	getVarTextHandling()
boolean	isIncludeVarText()
void	text(String text)	Text for processing
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

Field Details

REGEX_ESCAPE

public static final String REGEX_ESCAPE

See Also:

Constant Field Values

Constructor Details

FilterTemplateOutputHandler

@Deprecated public FilterTemplateOutputHandler(boolean includeVarText)

Deprecated.

Parameters:

includeVarText - if true, include the default variable text

FilterTemplateOutputHandler

public FilterTemplateOutputHandler(FilterTemplateOutputHandler.VarTextHandling varTextHandling)

Parameters:

varTextHandling - include original, exclude, or include the regex (enclosed with "~~~") for "var" text

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

completeParsing

public void completeParsing()

Description copied from interface: ILicenseTemplateOutputHandler

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

Specified by:

completeParsing in interface ILicenseTemplateOutputHandler

isIncludeVarText

public boolean isIncludeVarText()

Returns:

the includeVarText

getVarTextHandling

public FilterTemplateOutputHandler.VarTextHandling getVarTextHandling()

Returns:

the varTextHandling

getFilteredText

public List<String> getFilteredText()

Returns:

the filteredText