Package org.spdx.library.model

Class Relationship

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.Relationship

All Implemented Interfaces:

Comparable<Relationship>

public class Relationship
extends ModelObject
implements Comparable<Relationship>

A Relationship represents a relationship between two SpdxElements.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

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

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
int	compareTo(Relationship o)
Optional<String>	getComment()
Optional<SpdxElement>	getRelatedSpdxElement()
RelationshipType	getRelationshipType()
String	getType()
Relationship	setComment(String comment)
Relationship	setRelatedSpdxElement(SpdxElement relatedSpdxElement)
Relationship	setRelationshipType(RelationshipType type)	Set the relationship type
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

Relationship

public Relationship()
             throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

Relationship

public Relationship(String id)
             throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

Relationship

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

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

getRelationshipType

public RelationshipType getRelationshipType()
                                     throws InvalidSPDXAnalysisException

Returns:

the relationshipType

Throws:

InvalidSPDXAnalysisException

setRelationshipType

public Relationship setRelationshipType(RelationshipType type)
                                 throws InvalidSPDXAnalysisException

Set the relationship type

Parameters:

type -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getComment

public Optional<String> getComment()
                            throws InvalidSPDXAnalysisException

Returns:

the comment

Throws:

InvalidSPDXAnalysisException

setComment

public Relationship setComment(String comment)
                        throws InvalidSPDXAnalysisException

Parameters:

comment - the comment to set

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getRelatedSpdxElement

public Optional<SpdxElement> getRelatedSpdxElement()
                                            throws InvalidSPDXAnalysisException

Returns:

the relatedSpdxElement

Throws:

InvalidSPDXAnalysisException

setRelatedSpdxElement

public Relationship setRelatedSpdxElement(SpdxElement relatedSpdxElement)
                                   throws InvalidSPDXAnalysisException

Parameters:

relatedSpdxElement - the relatedSpdxElement to set

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

compareTo

public int compareTo(Relationship o)

Specified by:

compareTo in interface Comparable<Relationship>

toString

public String toString()

Overrides:

toString in class ModelObject