Class LicenseV3JsonLdFormatWriter

java.lang.Object

org.spdx.licenselistpublisher.licensegenerator.LicenseV3JsonLdFormatWriter

All Implemented Interfaces:

ILicenseFormatWriter

public class LicenseV3JsonLdFormatWriter
extends Object
implements ILicenseFormatWriter

Writes SPDX JsonLD files compliant with the SPDX Spec version 3

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SPDX_V3_FOLDER_NAME
static final String	SPDX_V3_JSON_LD_FOLDER_NAME

Constructor Summary

Constructors

Constructor	Description
LicenseV3JsonLdFormatWriter(String version, String releaseDate, File jsonLdFolder)

Method Summary

Modifier and Type	Method	Description
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
static void	writeV3JsonLD(org.spdx.v3jsonldstore.JsonLDStore store, Path filePath, boolean pretty)

Methods inherited from class java.lang.Object

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

Field Details

SPDX_V3_FOLDER_NAME

public static final String SPDX_V3_FOLDER_NAME

See Also:

• Constant Field Values

SPDX_V3_JSON_LD_FOLDER_NAME

public static final String SPDX_V3_JSON_LD_FOLDER_NAME

See Also:

• Constant Field Values

Constructor Details

LicenseV3JsonLdFormatWriter

public LicenseV3JsonLdFormatWriter(String version,
 String releaseDate,
 File jsonLdFolder)
                            throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

version - License list version

releaseDate - release date for the license list

jsonLdFolder - Folder to output the license TOC file, the exception TOC file, all license and exception details

Throws:

org.spdx.core.InvalidSPDXAnalysisException - on error creating TOC stores and/or objects

Method Details

writeV3JsonLD

public static void writeV3JsonLD(org.spdx.v3jsonldstore.JsonLDStore store,
 Path filePath,
 boolean pretty)
                          throws LicenseGeneratorException

Parameters:

store - JSONLD store containing the data to write

filePath - file path for the resultant file

pretty - if true, the JSON LD file will be formatted to be (more) human readable

Throws:

LicenseGeneratorException - on any IO or SPDX parsing errors

writeLicense

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

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

LicenseGeneratorException

org.spdx.core.InvalidSPDXAnalysisException

org.spdx.licenseTemplate.InvalidLicenseTemplateException

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.licenseTemplate.InvalidLicenseTemplateException,
org.spdx.core.InvalidSPDXAnalysisException

Specified by:

writeException in interface ILicenseFormatWriter

Parameters:

exceptionContainer - Exception to be formatted and written

Throws:

IOException

LicenseGeneratorException

org.spdx.licenseTemplate.InvalidLicenseTemplateException

org.spdx.core.InvalidSPDXAnalysisException