Package org.spdx.library.model

Class SpdxConstantElement

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxConstantElement

All Implemented Interfaces:

IndividualUriValue

Direct Known Subclasses:

SpdxNoAssertionElement, SpdxNoneElement

public abstract class SpdxConstantElement
extends SpdxElement
implements IndividualUriValue

Type of SpdxElement which is a constant unmodifiable element

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
SpdxConstantElement(String id)
SpdxConstantElement(IModelStore modelStore, String documentUri, String id)

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	addAnnotation(Annotation annotation)	Add an annotation
boolean	addRelationship(Relationship relationship)	Add a relationship
boolean	equals(Object comp)
Collection<Annotation>	getAnnotations()
Collection<Relationship>	getRelationships()
String	getType()
int	hashCode()
boolean	removeAnnotation(Annotation annotation)	Remove an annotation
boolean	removeRelationship(Relationship relationship)	Remove a relationship
SpdxElement	setAnnotations(Collection<Annotation> annotations)	Clears and resets the annotations collection to the parameter
void	setComment(String comment)	Sets the comment
SpdxElement	setName(String name)	Set the name
SpdxElement	setRelationships(Collection<Relationship> relationships)	clear and reset the relationships to the paramater relationship

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

addNameToWarnings, getComment, getName, getNamePropertyName

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, 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, toString, 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

Methods inherited from interface org.spdx.library.model.IndividualUriValue

getIndividualURI

Constructor Details

SpdxConstantElement

public SpdxConstantElement(String id)
                    throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxConstantElement

public SpdxConstantElement(IModelStore modelStore,
 String documentUri,
 String id)
                    throws InvalidSPDXAnalysisException

Parameters:

modelStore - where the model is stored

documentUri - Unique document URI

id - ID for the constant element

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 SpdxElement

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

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

getAnnotations

public Collection<Annotation> getAnnotations()
                                      throws InvalidSPDXAnalysisException

Overrides:

getAnnotations in class SpdxElement

Returns:

Annotations

Throws:

InvalidSPDXAnalysisException

setAnnotations

public SpdxElement setAnnotations(Collection<Annotation> annotations)
                           throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Clears and resets the annotations collection to the parameter

Overrides:

setAnnotations in class SpdxElement

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

addAnnotation

public boolean addAnnotation(Annotation annotation)
                      throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Add an annotation

Overrides:

addAnnotation in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

removeAnnotation

public boolean removeAnnotation(Annotation annotation)
                         throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Remove an annotation

Overrides:

removeAnnotation in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

getRelationships

public Collection<Relationship> getRelationships()
                                          throws InvalidSPDXAnalysisException

Overrides:

getRelationships in class SpdxElement

Returns:

Relationships

Throws:

InvalidSPDXAnalysisException

setRelationships

public SpdxElement setRelationships(Collection<Relationship> relationships)
                             throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

clear and reset the relationships to the paramater relationship

Overrides:

setRelationships in class SpdxElement

Returns:

this to chain sets

Throws:

InvalidSPDXAnalysisException

addRelationship

public boolean addRelationship(Relationship relationship)
                        throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Add a relationship

Overrides:

addRelationship in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

removeRelationship

public boolean removeRelationship(Relationship relationship)
                           throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Remove a relationship

Overrides:

removeRelationship in class SpdxElement

Returns:

Throws:

InvalidSPDXAnalysisException

setComment

public void setComment(String comment)
                throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Sets the comment

Overrides:

setComment in class SpdxElement

Throws:

InvalidSPDXAnalysisException

setName

public SpdxElement setName(String name)
                    throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Set the name

Overrides:

setName in class SpdxElement

Returns:

this so that you can chain setters

Throws:

InvalidSPDXAnalysisException

equals

public boolean equals(Object comp)

Overrides:

equals in class ModelObject

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObject