Package 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	Description
static String	OPTIONAL_LICENSE_TEXT_CLASS
static String	REPLACEABLE_LICENSE_TEXT_CLASS

Constructor Summary

Constructors

Constructor	Description
HtmlTemplateOutputHandler()

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

text

public void text(String text)

Description copied from interface: ILicenseTemplateOutputHandler

Text for processing

Specified by:

text in interface ILicenseTemplateOutputHandler

Parameters:

text - text to be processed

variableRule

public void variableRule(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

Variable rule found within the template

Specified by:

variableRule in interface ILicenseTemplateOutputHandler

Parameters:

rule - license template rule

formatReplaceableHTML

public static String formatReplaceableHTML(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:

a replaceable string

formatReplaceabledHTML

@Deprecated
public static String formatReplaceabledHTML(String text,
                                            String id)

Deprecated.

Format HTML for a replaceable string

Parameters:

text - text for the optional license string

id - ID used for the div

Returns:

a replaceable string

escapeIdString

public static String escapeIdString(String id)

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

Parameters:

id - an SPDX ID string

Returns:

the id escaped for HTML

getHtml

public String getHtml()

Returns:

HTML result

beginOptional

public void beginOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

Begin optional rule found

Specified by:

beginOptional in interface ILicenseTemplateOutputHandler

Parameters:

rule - optional rule

formatStartOptionalHTML

public static String formatStartOptionalHTML(String id)

Format HTML for an optional string

Parameters:

id - ID used for the div

Returns:

a formated id for use in the div

formatEndOptionalHTML

public static String formatEndOptionalHTML(boolean inParagraph)

Parameters:

inParagraph - true if in a paragraph

Returns:

a string for formatting the end of an Optional HTML element

endOptional

public void endOptional(LicenseTemplateRule rule)

Description copied from interface: ILicenseTemplateOutputHandler

End optional rule found

Specified by:

endOptional in interface ILicenseTemplateOutputHandler

Parameters:

rule - end optional rule

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