Package org.spdx.library.model.license

Class LicenseException

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.license.LicenseException

Direct Known Subclasses:

ListedLicenseException

public class LicenseException
extends ModelObject

Represents an SPDX license exception as defined in the License Expression Language Used with the "with" unary expression.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
LicenseException(String id, String name, String text)
LicenseException(String id, String name, String text, String template, Collection<String> seeAlso, String comment)
LicenseException(String id, String name, String text, Collection<String> seeAlso, String comment)
LicenseException(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)	Create a new LicenseException 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
String	getComment()
String	getDeprecatedVersion()
String	getExample()	Deprecated.
String	getLicenseExceptionId()
String	getLicenseExceptionTemplate()
String	getLicenseExceptionText()
String	getName()
Collection<String>	getSeeAlso()
String	getType()
boolean	isDeprecated()
void	setComment(String comment)
void	setDeprecated(Boolean deprecated)
void	setDeprecatedVersion(String deprecatedVersion)
void	setExample(String example)	Deprecated.
void	setLicenseExceptionTemplate(String template)	Set the template text for the exception
void	setLicenseExceptionText(String text)	Sets the text for the exception
void	setName(String name)
void	setSeeAlso(Collection<String> seeAlso)
String	toString()

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, equals, equivalent, equivalent, getAnyLicenseInfoPropertyValue, getBooleanPropertyValue, getCopyManager, getDocumentUri, getElementPropertyValue, getEnumPropertyValue, getId, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getPropertyValueNames, getStringCollection, getStringPropertyValue, 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

LicenseException

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

Create a new LicenseException object

Parameters:

modelStore - container which includes the license exception

documentUri - URI for the SPDX document containing the license exception

id - identifier for the license exception

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 exception if it does not exist

Throws:

InvalidSPDXAnalysisException

LicenseException

public LicenseException(String id,
 String name,
 String text,
 Collection<String> seeAlso,
 String comment)
                 throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

LicenseException

public LicenseException(String id,
 String name,
 String text,
 String template,
 Collection<String> seeAlso,
 String comment)
                 throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

LicenseException

public LicenseException(String id,
 String name,
 String text)
                 throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

Method Details

getComment

public String getComment()
                  throws InvalidSPDXAnalysisException

Returns:

Comment associated with the License Exception

Throws:

InvalidSPDXAnalysisException

setComment

public void setComment(String comment)
                throws InvalidSPDXAnalysisException

Parameters:

comment - the comment to set

Throws:

InvalidSPDXAnalysisException

getExample

@Deprecated
public String getExample()
                  throws InvalidSPDXAnalysisException

Deprecated.

Deprecated since SPDX spec 2.0

Returns:

example text

Throws:

InvalidSPDXAnalysisException

setExample

@Deprecated
public void setExample(String example)
                throws InvalidSPDXAnalysisException

Deprecated.

Deprecated since SPDX spec 2.0

Parameters:

example -

Throws:

InvalidSPDXAnalysisException

getLicenseExceptionId

public String getLicenseExceptionId()

Returns:

the id

getLicenseExceptionTemplate

public String getLicenseExceptionTemplate()
                                   throws InvalidSPDXAnalysisException

Returns:

the template

Throws:

InvalidSPDXAnalysisException

setLicenseExceptionTemplate

public void setLicenseExceptionTemplate(String template)
                                 throws InvalidSPDXAnalysisException

Set the template text for the exception

Parameters:

template - template

Throws:

InvalidSPDXAnalysisException

getLicenseExceptionText

public String getLicenseExceptionText()
                               throws InvalidSPDXAnalysisException

Returns:

the text

Throws:

InvalidSPDXAnalysisException

setLicenseExceptionText

public void setLicenseExceptionText(String text)
                             throws InvalidSPDXAnalysisException

Sets the text for the exception

Parameters:

text - text

Throws:

InvalidSPDXAnalysisException

getName

public String getName()
               throws InvalidSPDXAnalysisException

Returns:

the name

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setName

public void setName(String name)
             throws InvalidSPDXAnalysisException

Parameters:

name - the name to set

Throws:

InvalidSPDXAnalysisException

getSeeAlso

public Collection<String> getSeeAlso()
                              throws InvalidSPDXAnalysisException

Returns:

the urls which reference the same license information

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setSeeAlso

public void setSeeAlso(Collection<String> seeAlso)
                throws InvalidSPDXAnalysisException

Parameters:

seeAlso - the urls which are references to the same license to set

Throws:

InvalidSPDXAnalysisException

isDeprecated

public boolean isDeprecated()
                     throws InvalidSPDXAnalysisException

Returns:

true if this license is marked as being deprecated

Throws:

SpdxInvalidTypeException

InvalidSPDXAnalysisException

setDeprecated

public void setDeprecated(Boolean deprecated)
                   throws InvalidSPDXAnalysisException

Parameters:

deprecated - true if this license is deprecated

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

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

_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

toString

public String toString()

Overrides:

toString in class ModelObject