Package org.spdx.library.model.license

Class ListedLicenseException

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.license.LicenseException

org.spdx.library.model.license.ListedLicenseException

public class ListedLicenseException
extends LicenseException

Represents a License Exception present on the SPDX License List

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
ListedLicenseException(String id, String name, String text)
ListedLicenseException(String id, String name, String text, String template, Collection<String> seeAlso, String comment)
ListedLicenseException(String id, String name, String text, Collection<String> seeAlso, String comment)
ListedLicenseException(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Method Summary

Modifier and Type	Method	Description
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
String	getExceptionTextHtml()
String	getType()
void	setExceptionTextHtml(String exceptionTextHtml)

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

_verify, getComment, getDeprecatedVersion, getExample, getLicenseExceptionId, getLicenseExceptionTemplate, getLicenseExceptionText, getName, getSeeAlso, isDeprecated, setComment, setDeprecated, setDeprecatedVersion, setExample, setLicenseExceptionTemplate, setLicenseExceptionText, setName, setSeeAlso, 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, 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, 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

ListedLicenseException

public ListedLicenseException(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create) throws InvalidSPDXAnalysisException

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

ListedLicenseException

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

Parameters:

id -

name -

text -

seeAlso -

comment -

Throws:

InvalidSPDXAnalysisException

ListedLicenseException

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

Parameters:

id -

name -

text -

template -

seeAlso -

comment -

Throws:

InvalidSPDXAnalysisException

ListedLicenseException

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

Parameters:

id -

name -

text -

Throws:

InvalidSPDXAnalysisException

Method Details

getType

public String getType()

Overrides:

getType in class LicenseException

Returns:

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

setExceptionTextHtml

public void setExceptionTextHtml(String exceptionTextHtml) throws InvalidSPDXAnalysisException

Parameters:

exceptionTextHtml -

Throws:

InvalidSPDXAnalysisException

getExceptionTextHtml

public String getExceptionTextHtml() throws InvalidSPDXAnalysisException

Returns:

HTML form of the exception text either from a stored property or generated from the template or text

Throws:

InvalidSPDXAnalysisException

equivalent

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

Overrides:

equivalent in class ModelObject

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