org.spdx.html

Class LicenseTOCJSONFile

java.lang.Object

org.spdx.html.AbstractJsonFile

org.spdx.html.LicenseTOCJSONFile

public class LicenseTOCJSONFile
extends AbstractJsonFile

This class holds a JSON file for a license table of contents

Author:

Kyle E. Mitchell

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_REFERENCE_FIELD

Constructor Summary

Constructors

Constructor and Description
LicenseTOCJSONFile(String version, String releaseDate)

Method Summary

Modifier and Type	Method and Description
void	addLicense(SpdxListedLicense license, String licHTMLReference, String licJSONReference, boolean deprecated) Add a license to the JSON table of contents file
protected org.json.simple.JSONObject	getJsonObject()

Methods inherited from class org.spdx.html.AbstractJsonFile

writeToFile

Methods inherited from class java.lang.Object

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

Field Detail

JSON_REFERENCE_FIELD

public static final String JSON_REFERENCE_FIELD

See Also:

Constant Field Values

Constructor Detail

LicenseTOCJSONFile

public LicenseTOCJSONFile(String version,
                          String releaseDate)

Method Detail

addLicense

public void addLicense(SpdxListedLicense license,
                       String licHTMLReference,
                       String licJSONReference,
                       boolean deprecated)

Add a license to the JSON table of contents file

Parameters:

license - License to be added

licHTMLReference - file path to the license file HTML

licHTMLReference - file path to the license file JSON detail

deprecated - true if the license ID is deprecated

getJsonObject

protected org.json.simple.JSONObject getJsonObject()

Specified by:

getJsonObject in class AbstractJsonFile

Returns:

the JsonObject to be written