org.spdx.licenselistpublisher.licensegenerator

Interface ILicenseFormatWriter

All Known Implementing Classes:

LicenseHtmlFormatWriter, LicenseJsonFormatWriter, LicenseMarkdownFormatWriter, LicenseRdfaFormatWriter, LicenseRdfFormatWriter, LicenseTemplateFormatWriter, LicenseTextFormatWriter, SpdxWebsiteFormatWriter

public interface ILicenseFormatWriter

Writes licenses in a specific format

Author:

Gary O'Neall

Method Summary

Modifier and Type	Method and Description
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

Method Detail

writeLicense

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

Formats and writes a specific license

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

void writeToC()
       throws IOException,
              LicenseGeneratorException

Write the Table of Contents file for the format if applicable

Throws:

IOException

LicenseGeneratorException

writeException

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

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

LicenseGeneratorException

org.spdx.html.InvalidLicenseTemplateException