Interface ILicenseFormatWriter
- All Known Implementing Classes:
LicenseHtmlFormatWriter,LicenseJsonFormatWriter,LicenseMarkdownFormatWriter,LicenseRdfaFormatWriter,LicenseRdfFormatWriter,LicenseTemplateFormatWriter,LicenseTextFormatWriter,LicenseV3JsonLdFormatWriter,SpdxWebsiteFormatWriter
public interface ILicenseFormatWriter
Writes licenses in a specific format
- Author:
- Gary O'Neall
-
Method Summary
Modifier and TypeMethodDescriptionvoidwriteException(ListedExceptionContainer exceptionContainer) voidwriteLicense(ListedLicenseContainer licenseContainer, boolean deprecated, String deprecatedVersion) Formats and writes a specific licensevoidwriteToC()Write the Table of Contents file for the format if applicable
-
Method Details
-
writeLicense
void writeLicense(ListedLicenseContainer licenseContainer, boolean deprecated, String deprecatedVersion) throws IOException, LicenseGeneratorException, org.spdx.core.InvalidSPDXAnalysisException, org.spdx.licenseTemplate.InvalidLicenseTemplateException Formats and writes a specific license- Parameters:
licenseContainer- License to be addeddeprecated- True if deprecateddeprecatedVersion- License list version when the license was deprecated, null otherwise- Throws:
IOExceptionLicenseGeneratorExceptionorg.spdx.core.InvalidSPDXAnalysisExceptionorg.spdx.licenseTemplate.InvalidLicenseTemplateException
-
writeToC
Write the Table of Contents file for the format if applicable- Throws:
IOExceptionLicenseGeneratorException
-
writeException
void writeException(ListedExceptionContainer exceptionContainer) throws IOException, LicenseGeneratorException, org.spdx.licenseTemplate.InvalidLicenseTemplateException, org.spdx.core.InvalidSPDXAnalysisException - Parameters:
exceptionContainer- Exception to be formatted and written- Throws:
IOExceptionLicenseGeneratorExceptionorg.spdx.licenseTemplate.InvalidLicenseTemplateExceptionorg.spdx.core.InvalidSPDXAnalysisException
-