Interface IListedLicenseStore

All Superinterfaces:

AutoCloseable, org.spdx.storage.IModelStore

All Known Implementing Classes:

SpdxListedLicenseLocalStore, SpdxListedLicenseModelStore, SpdxListedLicenseWebStore

public interface IListedLicenseStore
extends org.spdx.storage.IModelStore

Extends the model store to include interfaces specific to listed licenses

Author:

Gary O'Neall

Nested Class Summary

Nested classes/interfaces inherited from interface org.spdx.storage.IModelStore

org.spdx.storage.IModelStore.IdType, org.spdx.storage.IModelStore.IModelStoreLock, org.spdx.storage.IModelStore.ModelUpdate

Method Summary

Modifier and Type	Method	Description
String	getLicenseListVersion()
org.spdx.library.model.v3_0_1.core.CreationInfo	getListedLicenseCreationInfo()
List<String>	getSpdxListedExceptionIds()
List<String>	getSpdxListedLicenseIds()
boolean	isSpdxListedExceptionId(String listedLicenseDocumentUri, String exceptionId)
boolean	isSpdxListedLicenseId(String listedLicenseDocumentUri, String licenseId)
Optional<String>	listedExceptionIdCaseSensitive(String exceptionId)
Optional<String>	listedLicenseIdCaseSensitive(String licenseId)

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.spdx.storage.IModelStore

addValueToCollection, clearValueCollection, collectionContains, collectionSize, create, delete, enterCriticalSection, exists, getAllItems, getCaseSensisitiveId, getCaseSensitiveId, getIdType, getNextId, getPropertyValueDescriptors, getTypedValue, getValue, isAnon, isCollectionMembersAssignableTo, isCollectionProperty, isPropertyValueAssignableTo, leaveCriticalSection, listValues, removeProperty, removeValueFromCollection, setValue

Method Details

getSpdxListedLicenseIds

List<String> getSpdxListedLicenseIds()

Returns:

List of all SPDX listed license IDs

getLicenseListVersion

String getLicenseListVersion()

Returns:

The version of the loaded license list in the form M.N, where M is the major release and N is the minor release.

isSpdxListedLicenseId

boolean isSpdxListedLicenseId(String listedLicenseDocumentUri,
 String licenseId)

Parameters:

listedLicenseDocumentUri - Document URI for the listed license

licenseId - ID for the license

Returns:

true if the licenseId belongs to an SPDX listed license

isSpdxListedExceptionId

boolean isSpdxListedExceptionId(String listedLicenseDocumentUri,
 String exceptionId)

Parameters:

listedLicenseDocumentUri - Document URI for the listed exception

exceptionId - ID for the exception

Returns:

true if the exceptionId belongs to an SPDX listed exception

getSpdxListedExceptionIds

List<String> getSpdxListedExceptionIds()

Returns:

list of SPDX exception IDs

listedLicenseIdCaseSensitive

Optional<String> listedLicenseIdCaseSensitive(String licenseId)

Parameters:

licenseId - case insensitive license ID

Returns:

the case-sensitive license ID

listedExceptionIdCaseSensitive

Optional<String> listedExceptionIdCaseSensitive(String exceptionId)

Parameters:

exceptionId - case-insensitive exception ID

Returns:

case sensitive ID

getListedLicenseCreationInfo

org.spdx.library.model.v3_0_1.core.CreationInfo getListedLicenseCreationInfo()
                                                                      throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the CreationInfo used for all SPDX listed licenses and listed exceptions

Throws:

org.spdx.core.InvalidSPDXAnalysisException - on error inflating the creation info