Package org.spdx.library.model

Class SpdxElement

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

Direct Known Subclasses:

ExternalSpdxElement, GenericSpdxElement, SpdxConstantElement, SpdxDocument, SpdxItem

public abstract class SpdxElement
extends ModelObject

An SpdxElement is any thing described in SPDX, either a document or an SpdxItem. SpdxElements can be related to other SpdxElements. If a subproperty is used for the name property name, getNamePropertyName should be overridden.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
SpdxElement()
SpdxElement(String id)
SpdxElement(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, boolean create)

Method Summary

Modifier and Type	Method	Description
protected List<String>	_verify(Set<String> verifiedElementIds, String specVersion)	Implementation of the specific verifications for this model object
boolean	addAnnotation(Annotation annotation)	Add an annotation
protected List<String>	addNameToWarnings(List<String> warnings)	Add the name of the element to all strings in the list
boolean	addRelationship(Relationship relationship)	Add a relationship
Collection<Annotation>	getAnnotations()
Optional<String>	getComment()
Optional<String>	getName()
protected String	getNamePropertyName()
Collection<Relationship>	getRelationships()
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.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, getType, hashCode, 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

Constructor Details

SpdxElement

public SpdxElement()
            throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxElement

public SpdxElement(String id)
            throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SpdxElement

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

Parameters:

modelStore -

documentUri -

id -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

_verify

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

Description copied from class: ModelObject

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObject

Parameters:

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

addNameToWarnings

protected List<String> addNameToWarnings(List<String> warnings)

Add the name of the element to all strings in the list

Parameters:

warnings -

Returns:

the same last after being modified (Note: a new list is not created - this modifies the warnings list)

getAnnotations

public Collection<Annotation> getAnnotations()
                                      throws InvalidSPDXAnalysisException

Returns:

Annotations

Throws:

InvalidSPDXAnalysisException

setAnnotations

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

Clears and resets the annotations collection to the parameter

Parameters:

annotations -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

addAnnotation

public boolean addAnnotation(Annotation annotation)
                      throws InvalidSPDXAnalysisException

Add an annotation

Parameters:

annotation -

Returns:

Throws:

InvalidSPDXAnalysisException

removeAnnotation

public boolean removeAnnotation(Annotation annotation)
                         throws InvalidSPDXAnalysisException

Remove an annotation

Parameters:

annotation -

Returns:

Throws:

InvalidSPDXAnalysisException

getRelationships

public Collection<Relationship> getRelationships()
                                          throws InvalidSPDXAnalysisException

Returns:

Relationships

Throws:

InvalidSPDXAnalysisException

setRelationships

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

clear and reset the relationships to the paramater relationship

Parameters:

relationships -

Returns:

this to chain sets

Throws:

InvalidSPDXAnalysisException

addRelationship

public boolean addRelationship(Relationship relationship)
                        throws InvalidSPDXAnalysisException

Add a relationship

Parameters:

relationship -

Returns:

Throws:

InvalidSPDXAnalysisException

removeRelationship

public boolean removeRelationship(Relationship relationship)
                           throws InvalidSPDXAnalysisException

Remove a relationship

Parameters:

relationship -

Returns:

Throws:

InvalidSPDXAnalysisException

getComment

public Optional<String> getComment()
                            throws InvalidSPDXAnalysisException

Returns:

the comment

Throws:

InvalidSPDXAnalysisException

setComment

public void setComment(String comment)
                throws InvalidSPDXAnalysisException

Sets the comment

Parameters:

comment -

Throws:

InvalidSPDXAnalysisException

getNamePropertyName

protected String getNamePropertyName()

Returns:

the property name used for the Name property. Override this function if using a subproperty of SPDX Name

getName

public Optional<String> getName()
                         throws InvalidSPDXAnalysisException

Returns:

the name

Throws:

InvalidSPDXAnalysisException

setName

public SpdxElement setName(String name)
                    throws InvalidSPDXAnalysisException

Set the name

Parameters:

name -

Returns:

this so that you can chain setters

Throws:

InvalidSPDXAnalysisException