org.spdx.licenseTemplate

Class HtmlTemplateOutputHandler

java.lang.Object

org.spdx.licenseTemplate.HtmlTemplateOutputHandler

All Implemented Interfaces:

ILicenseTemplateOutputHandler

public class HtmlTemplateOutputHandler
extends Object
implements ILicenseTemplateOutputHandler

License template output handler for generating an HTML version of a license from a license template. Used when parsing a license template.

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTIONAL_LICENSE_TEXT_CLASS
static String	REPLACEABLE_LICENSE_TEXT_CLASS

Constructor Summary

Constructors

Constructor and Description
HtmlTemplateOutputHandler()

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
static String	escapeIdString(String id) Escape the ID string to conform to the legal characters for an HTML ID string
static String	formatEndOptionalHTML()
static String	formatReplaceabledHTML(String text, String id) Format HTML for a replaceable string
static String	formatStartOptionalHTML(String id) Format HTML for an optional string
String	getHtml()
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
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 Detail

REPLACEABLE_LICENSE_TEXT_CLASS

public static final String REPLACEABLE_LICENSE_TEXT_CLASS

See Also:

Constant Field Values

OPTIONAL_LICENSE_TEXT_CLASS

public static final String OPTIONAL_LICENSE_TEXT_CLASS

See Also:

Constant Field Values

Constructor Detail

HtmlTemplateOutputHandler

public HtmlTemplateOutputHandler()

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

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

formatReplaceabledHTML

public static String formatReplaceabledHTML(String text,
                            String id)

Format HTML for a replaceable string

Parameters:

text - text for the optional license string

id - ID used for the div

Returns:

escapeIdString

public static String escapeIdString(String id)

Escape the ID string to conform to the legal characters for an HTML ID string

Parameters:

id -

Returns:

getHtml

public String getHtml()

Returns:

beginOptional

public void beginOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

Begin optional rule found

Specified by:

beginOptional in interface ILicenseTemplateOutputHandler

formatStartOptionalHTML

public static String formatStartOptionalHTML(String id)

Format HTML for an optional string

Parameters:

text - text for the optional license string

id - ID used for the div

Returns:

formatEndOptionalHTML

public static String formatEndOptionalHTML()

endOptional

public void endOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

End optional rule found

Specified by:

endOptional in interface ILicenseTemplateOutputHandler