org.spdx.html

Class LicenseHTMLFile

java.lang.Object

org.spdx.html.LicenseHTMLFile

public class LicenseHTMLFile
extends Object

This class contains a formatted HTML file for a given license. Specific formatting information is contained in this file.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LicenseHTMLFile.FormattedUrl Parses a URL and stores the site name and the original URL

Constructor Summary

Constructors

Constructor and Description
LicenseHTMLFile()
LicenseHTMLFile(SpdxListedLicense license, boolean isDeprecated, String deprecatedVersion)

Method Summary

Modifier and Type	Method and Description
String	getDeprecatedVersion()
SpdxListedLicense	getLicense()
boolean	isDeprecated()
void	setDeprecated(boolean isDeprecated)
void	setDeprecatedVersion(String deprecatedVersion)
void	setLicense(SpdxListedLicense license)
void	writeToFile(File htmlFile, String tableOfContentsReference)

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseHTMLFile

public LicenseHTMLFile(SpdxListedLicense license,
                       boolean isDeprecated,
                       String deprecatedVersion)

Parameters:

templateFileName - File name for the Mustache template file

license - Listed license to be used

isDeprecated - True if the license has been deprecated

deprecatedVersion - Version since the license has been deprecated (null if not deprecated)

LicenseHTMLFile

public LicenseHTMLFile()

Method Detail

getLicense

public SpdxListedLicense getLicense()

Returns:

the license

setLicense

public void setLicense(SpdxListedLicense license)

Parameters:

license - the license to set

isDeprecated

public boolean isDeprecated()

Returns:

the isDeprecated

setDeprecated

public void setDeprecated(boolean isDeprecated)

Parameters:

isDeprecated - the isDeprecated to set

getDeprecatedVersion

public String getDeprecatedVersion()

Returns:

the deprecatedVersion

setDeprecatedVersion

public void setDeprecatedVersion(String deprecatedVersion)

Parameters:

deprecatedVersion - the deprecatedVersion to set

writeToFile

public void writeToFile(File htmlFile,
                        String tableOfContentsReference)
                 throws IOException,
                        com.github.mustachejava.MustacheException,
                        InvalidLicenseTemplateException

Throws:

IOException

com.github.mustachejava.MustacheException

InvalidLicenseTemplateException