Class LicenseTemplateFormatWriter

java.lang.Object

org.spdx.licenselistpublisher.licensegenerator.LicenseTemplateFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class LicenseTemplateFormatWriter
extends Object
implements ILicenseFormatWriter

Write license template format as described in the SPDX spec

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor	Description
LicenseTemplateFormatWriter(File templateFolder)

Method Summary

Modifier and Type	Method	Description
File	getTemplateFolder()
void	setTemplateFolder(File templateFolder)
void	writeException(ListedExceptionContainer exceptionContainer)
void	writeLicense(ListedLicenseContainer licenseContainer, 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 Details

LicenseTemplateFormatWriter

public LicenseTemplateFormatWriter(File templateFolder)

Parameters:

templateFolder - Folder containing the template files

Method Details

getTemplateFolder

public File getTemplateFolder()

Returns:

the templateFolder

setTemplateFolder

public void setTemplateFolder(File templateFolder)

Parameters:

templateFolder - the templateFolder to set

writeLicense

public void writeLicense(ListedLicenseContainer licenseContainer,
 boolean deprecated,
 String deprecatedVersion)
                  throws IOException,
org.spdx.core.InvalidSPDXAnalysisException

Description copied from interface: ILicenseFormatWriter

Formats and writes a specific license

Specified by:

writeLicense in interface ILicenseFormatWriter

Parameters:

licenseContainer - License to be added

deprecated - True if deprecated

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

Throws:

IOException

org.spdx.core.InvalidSPDXAnalysisException

writeToC

public void writeToC()
              throws IOException,
LicenseGeneratorException

Description copied from interface: ILicenseFormatWriter

Write the Table of Contents file for the format if applicable

Specified by:

writeToC in interface ILicenseFormatWriter

Throws:

IOException

LicenseGeneratorException

writeException

public void writeException(ListedExceptionContainer exceptionContainer)
                    throws IOException,
LicenseGeneratorException,
org.spdx.core.InvalidSPDXAnalysisException

Specified by:

writeException in interface ILicenseFormatWriter

Parameters:

exceptionContainer - Exception to be formatted and written

Throws:

IOException

LicenseGeneratorException

org.spdx.core.InvalidSPDXAnalysisException