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	Description
static class	LicenseHTMLFile.FormattedUrl	Parses a URL and stores the site name and the original URL

Constructor Summary

Constructors

Constructor	Description
LicenseHTMLFile()
LicenseHTMLFile(org.spdx.library.model.v2.license.SpdxListedLicense license)

Method Summary

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

LicenseHTMLFile

public LicenseHTMLFile(org.spdx.library.model.v2.license.SpdxListedLicense license)

Parameters:

license - Listed license to be used

LicenseHTMLFile

public LicenseHTMLFile()

Method Details

getLicense

public org.spdx.library.model.v2.license.SpdxListedLicense getLicense()

Returns:

the license

setLicense

public void setLicense(org.spdx.library.model.v2.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.licenseTemplate.InvalidLicenseTemplateException,
org.spdx.core.InvalidSPDXAnalysisException

Throws:

IOException

com.github.mustachejava.MustacheException

org.spdx.licenseTemplate.InvalidLicenseTemplateException

org.spdx.core.InvalidSPDXAnalysisException