org.spdx.tools.licensegenerator

Class LicenseJsonFormatWriter

java.lang.Object

org.spdx.tools.licensegenerator.LicenseJsonFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class LicenseJsonFormatWriter
extends Object
implements ILicenseFormatWriter

Writes JSON format license information

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
LicenseJsonFormatWriter(String version, String releaseDate, File jsonFolder, File jsonFolderDetails, File jsonFolderExceptions)

Method Summary

Modifier and Type	Method and Description
File	getJsonFolder()
File	getJsonFolderDetails()
File	getJsonFolderExceptions()
void	setJsonFolder(File jsonFolder)
void	setJsonFolderDetails(File jsonFolderDetails)
void	setJsonFolderExceptions(File jsonFolderExceptions)
void	writeException(LicenseException exception, boolean deprecated, String deprecatedVersion)
void	writeLicense(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

LicenseJsonFormatWriter

public LicenseJsonFormatWriter(String version,
                               String releaseDate,
                               File jsonFolder,
                               File jsonFolderDetails,
                               File jsonFolderExceptions)

Parameters:

version - License list version

releaseDate - release date for the license list

jsonFolder - Folder to output the main JSON file

jsonFolderDetails - Folder to output a detailed JSON file per license

jsonFolderExceptions - Folder to output a detailed JSON file per exception

Method Detail

getJsonFolder

public File getJsonFolder()

Returns:

the jsonFolder

setJsonFolder

public void setJsonFolder(File jsonFolder)

Parameters:

jsonFolder - the jsonFolder to set

getJsonFolderExceptions

public File getJsonFolderExceptions()

Returns:

the jsonFolderExceptions

setJsonFolderExceptions

public void setJsonFolderExceptions(File jsonFolderExceptions)

Parameters:

jsonFolderExceptions - the jsonFolderExceptions to set

getJsonFolderDetails

public File getJsonFolderDetails()

Returns:

the jsonFolderDetails

setJsonFolderDetails

public void setJsonFolderDetails(File jsonFolderDetails)

Parameters:

jsonFolderDetails - the jsonFolderDetails to set

writeLicense

public void writeLicense(SpdxListedLicense license,
                         boolean deprecated,
                         String deprecatedVersion)
                  throws IOException

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

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(LicenseException exception,
                           boolean deprecated,
                           String deprecatedVersion)
                    throws IOException

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