Package org.spdx.library.model.license

Class SpdxListedLicense

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.license.AnyLicenseInfo

org.spdx.library.model.license.SimpleLicensingInfo

org.spdx.library.model.license.License

org.spdx.library.model.license.SpdxListedLicense

public class SpdxListedLicense
extends License

Listed license for SPDX as listed at spdx.org/licenses

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpdxListedLicense.Builder

Field Summary

Fields inherited from class org.spdx.library.model.ModelObject

strict

Constructor Summary

Constructors

Constructor	Description
SpdxListedLicense(String id)	Open or create a model object with the default store and default document URI
SpdxListedLicense(String name, String id, String text, Collection<String> sourceUrl, String comments, String standardLicenseHeader, String template, boolean osiApproved, Boolean fsfLibre, String licenseTextHtml, boolean isDeprecated, String deprecatedVersion)
SpdxListedLicense(SpdxListedLicense.Builder builder)
SpdxListedLicense(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new SPDX Listed License object

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(Set<String> verifiedIds, String specVersion)	Implementation of the specific verifications for this model object
boolean	equals(Object compare)
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
Collection<CrossRef>	getCrossRef()
String	getDeprecatedVersion()
String	getLicenseHeaderHtml()
String	getLicenseTextHtml()
String	getType()
int	hashCode()
void	setDeprecatedVersion(String deprecatedVersion)
void	setLicenseHeaderHtml(String licenseHeaderHtml)	Set the licenseHeaderTemplateHtml
void	setLicenseTextHtml(String licenseTextHtml)	Set the licenseTextHtml

Methods inherited from class org.spdx.library.model.license.License

getFsfLibre, getLicenseText, getStandardLicenseHeader, getStandardLicenseHeaderTemplate, getStandardLicenseTemplate, isDeprecated, isFsfLibre, isNotFsfLibre, isOsiApproved, setDeprecated, setFsfLibre, setLicenseText, setOsiApproved, setStandardLicenseHeader, setStandardLicenseHeaderTemplate, setStandardLicenseTemplate, toString, updateSetDeprecated

Methods inherited from class org.spdx.library.model.license.SimpleLicensingInfo

getComment, getLicenseId, getName, getSeeAlso, setComment, setName, setSeeAlso

Methods inherited from class org.spdx.library.model.ModelObject

addPropertyValueToCollection, addValueToCollection, clearValueCollection, clearValueCollection, clone, copyFrom, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createExtractedLicense, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, enterCriticalSection, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, idToIdType, isCollectionMembersAssignableTo, isStrict, leaveCriticalSection, removeProperty, removeProperty, removePropertyValueFromCollection, removePropertyValueFromCollection, replacePropertyValueCollection, setCopyManager, setPropertyValue, setPropertyValue, setStrict, toTypedValue, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SpdxListedLicense

public SpdxListedLicense(String id)
                  throws InvalidSPDXAnalysisException

Open or create a model object with the default store and default document URI

Parameters:

id - ID for this object - must be unique within the SPDX document

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(IModelStore modelStore,
 String documentUri,
 String id,
 @Nullable
 ModelCopyManager copyManager,
 boolean create)
                  throws InvalidSPDXAnalysisException

Create a new SPDX Listed License object

Parameters:

modelStore - container which includes the license

documentUri - URI for the SPDX document containing the license

id - identifier for the license

copyManager - if non-null, allows for copying of any properties set which use other model stores or document URI's

create - if true, create the license if it does not exist

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(String name,
 String id,
 String text,
 Collection<String> sourceUrl,
 String comments,
 String standardLicenseHeader,
 String template,
 boolean osiApproved,
 Boolean fsfLibre,
 String licenseTextHtml,
 boolean isDeprecated,
 String deprecatedVersion)
                  throws InvalidSPDXAnalysisException

Parameters:

name - License name

id - License ID

text - License text

sourceUrl - Optional URLs that reference this license

comments - Optional comments

standardLicenseHeader - Optional license header

template - Optional template

osiApproved - True if this is an OSI Approved license

fsfLibre - true if FSF describes the license as free / libre, false if FSF describes the license as not free / libre, null if FSF does not reference the license

licenseTextHtml - HTML version for the license text

isDeprecated - True if this license has been designated as deprecated by the SPDX legal team

deprecatedVersion - License list version when this license was first deprecated (null if not deprecated)

Throws:

InvalidSPDXAnalysisException

SpdxListedLicense

public SpdxListedLicense(SpdxListedLicense.Builder builder)
                  throws InvalidSPDXAnalysisException

Parameters:

builder - Builder configured with desired parameters

Throws:

InvalidSPDXAnalysisException

Method Details

_verify

protected List<String> _verify(Set<String> verifiedIds,
 String specVersion)

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Overrides:

_verify in class License

Parameters:

verifiedIds - list of all Element Id's which have already been verified - prevents infinite recursion

specVersion - Version of the SPDX spec to verify against

Returns:

Any verification errors or warnings associated with this object

getLicenseTextHtml

public String getLicenseTextHtml()
                          throws InvalidLicenseTemplateException,
InvalidSPDXAnalysisException

Returns:

HTML fragment containing the License Text

Throws:

InvalidLicenseTemplateException

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setLicenseTextHtml

public void setLicenseTextHtml(String licenseTextHtml)
                        throws InvalidSPDXAnalysisException

Set the licenseTextHtml

Parameters:

licenseTextHtml - HTML fragment representing the license text

Throws:

InvalidSPDXAnalysisException

getLicenseHeaderHtml

public String getLicenseHeaderHtml()
                            throws InvalidLicenseTemplateException,
InvalidSPDXAnalysisException

Returns:

HTML fragment containing the License standard header text

Throws:

InvalidLicenseTemplateException

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setLicenseHeaderHtml

public void setLicenseHeaderHtml(String licenseHeaderHtml)
                          throws InvalidSPDXAnalysisException

Set the licenseHeaderTemplateHtml

Parameters:

licenseHeaderHtml - HTML fragment representing the license standard header text

Throws:

InvalidSPDXAnalysisException

getDeprecatedVersion

public String getDeprecatedVersion()
                            throws InvalidSPDXAnalysisException

Returns:

the deprecatedVersion

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setDeprecatedVersion

public void setDeprecatedVersion(String deprecatedVersion)
                          throws InvalidSPDXAnalysisException

Parameters:

deprecatedVersion - the deprecatedVersion to set

Throws:

InvalidSPDXAnalysisException

getCrossRef

public Collection<CrossRef> getCrossRef()
                                 throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

getType

public String getType()

Specified by:

getType in class ModelObject

Returns:

The class name for this object. Class names are defined in the constants file

equivalent

public boolean equivalent(ModelObject compare,
 boolean ignoreRelatedElements)
                   throws InvalidSPDXAnalysisException

Overrides:

equivalent in class License

ignoreRelatedElements - if true, do not compare properties relatedSpdxElement - used to prevent infinite recursion

Returns:

true if all the properties have the same or equivalent values

Throws:

InvalidSPDXAnalysisException

equals

public boolean equals(Object compare)

Overrides:

equals in class ModelObject

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObject