Package org.spdx.library.model.license

Class License

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

Direct Known Subclasses:

SpdxListedLicense

public abstract class License
extends SimpleLicensingInfo

Describes a license All licenses have an ID. Subclasses should extend this class to add additional properties.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
License(String id)	Open or create a model object with the default store and default document URI

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	equivalent(ModelObject compare, boolean ignoreExternalReferences)
Boolean	getFsfLibre()
String	getLicenseText()
String	getStandardLicenseHeader()
String	getStandardLicenseHeaderTemplate()
String	getStandardLicenseTemplate()
boolean	isDeprecated()
boolean	isFsfLibre()
boolean	isNotFsfLibre()
boolean	isOsiApproved()
void	setDeprecated(Boolean deprecated)
void	setFsfLibre(Boolean fsfLibre)
void	setLicenseText(String text)
void	setOsiApproved(Boolean osiApproved)
void	setStandardLicenseHeader(String standardLicenseHeader)
void	setStandardLicenseHeaderTemplate(String standardLicenseHeaderTemplate)
void	setStandardLicenseTemplate(String template)
String	toString()
IModelStore.ModelUpdate	updateSetDeprecated(Boolean deprecated)

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, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, enterCriticalSection, equals, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, getType, hashCode, 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

License

public License(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

Method Details

getLicenseText

public String getLicenseText() throws InvalidSPDXAnalysisException

Returns:

the text of the license

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setLicenseText

public void setLicenseText(String text) throws InvalidSPDXAnalysisException

Parameters:

text - the license text to set

Throws:

InvalidSPDXAnalysisException

getStandardLicenseHeader

public String getStandardLicenseHeader() throws InvalidSPDXAnalysisException

Returns:

the standardLicenseHeader

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

getStandardLicenseHeaderTemplate

public String getStandardLicenseHeaderTemplate() throws InvalidSPDXAnalysisException

Returns:

standard license header template

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setStandardLicenseHeaderTemplate

public void setStandardLicenseHeaderTemplate(String standardLicenseHeaderTemplate) throws InvalidSPDXAnalysisException

Parameters:

standardLicenseHeaderTemplate -

Throws:

InvalidSPDXAnalysisException

setStandardLicenseHeader

public void setStandardLicenseHeader(String standardLicenseHeader) throws InvalidSPDXAnalysisException

Parameters:

standardLicenseHeader - the standardLicenseHeader to set

Throws:

InvalidSPDXAnalysisException

getStandardLicenseTemplate

public String getStandardLicenseTemplate() throws InvalidSPDXAnalysisException

Returns:

the template

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setStandardLicenseTemplate

public void setStandardLicenseTemplate(String template) throws InvalidSPDXAnalysisException

Parameters:

template - the template to set

Throws:

InvalidSPDXAnalysisException

toString

public String toString()

Specified by:

toString in class AnyLicenseInfo

_verify

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

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObject

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

isFsfLibre

public boolean isFsfLibre() throws InvalidSPDXAnalysisException

Returns:

true if FSF describes the license as free / libre, false if FSF describes the license as not free / libre or if FSF does not reference the license

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

isNotFsfLibre

public boolean isNotFsfLibre() throws InvalidSPDXAnalysisException

Returns:

true if FSF specified this license as not free/libre, false if it has been specified by the FSF as free / libre or if it has not been specified

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

getFsfLibre

public Boolean getFsfLibre() throws InvalidSPDXAnalysisException

Returns:

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

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

isOsiApproved

public boolean isOsiApproved() throws InvalidSPDXAnalysisException

Returns:

true if the license is listed as an approved license on the OSI website

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

isDeprecated

public boolean isDeprecated() throws InvalidSPDXAnalysisException

Returns:

true if this license is marked as being deprecated

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setOsiApproved

public void setOsiApproved(Boolean osiApproved) throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

setFsfLibre

public void setFsfLibre(Boolean fsfLibre) throws InvalidSPDXAnalysisException

Parameters:

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

Throws:

InvalidSPDXAnalysisException

setDeprecated

public void setDeprecated(Boolean deprecated) throws InvalidSPDXAnalysisException

Parameters:

deprecated - true if this license is deprecated

Throws:

InvalidSPDXAnalysisException

updateSetDeprecated

public IModelStore.ModelUpdate updateSetDeprecated(Boolean deprecated) throws InvalidSPDXAnalysisException

Parameters:

deprecated -

Returns:

a ModelUpdate that can be applied through the ModelObject

Throws:

InvalidSPDXAnalysisException

equivalent

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

Overrides:

equivalent in class ModelObject

ignoreExternalReferences - 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