org.spdx.licenselistpublisher.licensegenerator

Class SpdxWebsiteFormatWriter

java.lang.Object

org.spdx.licenselistpublisher.licensegenerator.SpdxWebsiteFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class SpdxWebsiteFormatWriter
extends Object
implements ILicenseFormatWriter

Writer to format all files for the https://spdx.org/licenses website

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
SpdxWebsiteFormatWriter(String version, String releaseDate, File websiteFolder)

Method Summary

Modifier and Type	Method and Description
org.spdx.html.ExceptionHtmlToc	getHtmlExceptionToc()
org.spdx.html.ExceptionTOCJSONFile	getJsonExceptionToc()
org.spdx.html.LicenseHTMLFile	getLicHtml()
org.spdx.html.LicenseJSONFile	getLicJson()
String	getReleaseDate()
org.spdx.html.LicenseTOCHTMLFile	getTableOfContentsHTML()
org.spdx.html.LicenseTOCJSONFile	getTableOfContentsJSON()
String	getVersion()
File	getWebsiteFolder()
void	setLicHtml(org.spdx.html.LicenseHTMLFile licHtml)
void	setReleaseDate(String releaseDate)
void	setTableOfContentsHTML(org.spdx.html.LicenseTOCHTMLFile tableOfContentsHTML)
void	setVersion(String version)
void	setWebsiteFolder(File websiteFolder)
void	writeException(org.spdx.rdfparser.license.LicenseException exception, boolean deprecated, String deprecatedVersion)
void	writeLicense(org.spdx.rdfparser.license.SpdxListedLicense license, boolean deprecated, String deprecatedVersion) Formats and writes a specific license
void	writeToC() Write the Table of Contents file for the format if applicable

Methods inherited from class java.lang.Object

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

Constructor Detail

SpdxWebsiteFormatWriter

public SpdxWebsiteFormatWriter(String version,
                               String releaseDate,
                               File websiteFolder)

Parameters:

version - License list version

releaseDate - release date for the license list

websiteFolder - Folder to store all of the website files

Method Detail

getVersion

public String getVersion()

Returns:

the version

setVersion

public void setVersion(String version)

Parameters:

version - the version to set

getReleaseDate

public String getReleaseDate()

Returns:

the releaseDate

setReleaseDate

public void setReleaseDate(String releaseDate)

Parameters:

releaseDate - the releaseDate to set

getLicJson

public org.spdx.html.LicenseJSONFile getLicJson()

Returns:

the licJson

getTableOfContentsJSON

public org.spdx.html.LicenseTOCJSONFile getTableOfContentsJSON()

Returns:

the tableOfContentsJSON

getHtmlExceptionToc

public org.spdx.html.ExceptionHtmlToc getHtmlExceptionToc()

Returns:

the htmlExceptionToc

getJsonExceptionToc

public org.spdx.html.ExceptionTOCJSONFile getJsonExceptionToc()

Returns:

the jsonExceptionToc

getWebsiteFolder

public File getWebsiteFolder()

Returns:

the websiteFolder

setWebsiteFolder

public void setWebsiteFolder(File websiteFolder)

Parameters:

websiteFolder - the websiteFolder to set

getLicHtml

public org.spdx.html.LicenseHTMLFile getLicHtml()

Returns:

the licHtml

setLicHtml

public void setLicHtml(org.spdx.html.LicenseHTMLFile licHtml)

Parameters:

licHtml - the licHtml to set

getTableOfContentsHTML

public org.spdx.html.LicenseTOCHTMLFile getTableOfContentsHTML()

Returns:

the tableOfContentsHTML

setTableOfContentsHTML

public void setTableOfContentsHTML(org.spdx.html.LicenseTOCHTMLFile tableOfContentsHTML)

Parameters:

tableOfContentsHTML - the tableOfContentsHTML to set

writeLicense

public void writeLicense(org.spdx.rdfparser.license.SpdxListedLicense license,
                         boolean deprecated,
                         String deprecatedVersion)
                  throws IOException,
                         LicenseGeneratorException

Description copied from interface: ILicenseFormatWriter

Formats and writes a specific license

Specified by:

writeLicense in interface ILicenseFormatWriter

Parameters:

license - License to be added

deprecated - True if deprecated

deprecatedVersion - License list version when the license was deprecated, null otherwise

Throws:

IOException

LicenseGeneratorException

writeToC

public void writeToC()
              throws IOException

Description copied from interface: ILicenseFormatWriter

Write the Table of Contents file for the format if applicable

Specified by:

writeToC in interface ILicenseFormatWriter

Throws:

IOException

writeException

public void writeException(org.spdx.rdfparser.license.LicenseException exception,
                           boolean deprecated,
                           String deprecatedVersion)
                    throws IOException,
                           org.spdx.html.InvalidLicenseTemplateException,
                           LicenseGeneratorException

Specified by:

writeException in interface ILicenseFormatWriter

Parameters:

exception - Exception to be formatted and written

deprecated - True if deprecated

deprecatedVersion - License list version when the license was deprecated, null otherwise

Throws:

IOException

org.spdx.html.InvalidLicenseTemplateException

LicenseGeneratorException