org.spdx.htmltemplates

Class LicenseHTMLFile

java.lang.Object

org.spdx.htmltemplates.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(org.spdx.rdfparser.license.SpdxListedLicense license)

Method Summary

Modifier and Type	Method and Description
org.spdx.rdfparser.license.SpdxListedLicense	getLicense()
void	setLicense(org.spdx.rdfparser.license.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(org.spdx.rdfparser.license.SpdxListedLicense license)

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 org.spdx.rdfparser.license.SpdxListedLicense getLicense()

Returns:

the license

setLicense

public void setLicense(org.spdx.rdfparser.license.SpdxListedLicense license)

Parameters:

license - the license to set

writeToFile

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

Throws:

IOException

com.github.mustachejava.MustacheException

org.spdx.html.InvalidLicenseTemplateException