Package org.spdx.library.model

Class ExternalRef

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.ExternalRef

All Implemented Interfaces:

Comparable<ExternalRef>

public class ExternalRef
extends ModelObject
implements Comparable<ExternalRef>

An External Reference allows a Package to reference an external source of additional information, metadata, enumerations, asset identifiers, or downloadable content believed to be relevant to the Package.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
ExternalRef()
ExternalRef(String id)
ExternalRef(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(ExternalRef o)
boolean	equivalent(ModelObject compare, boolean ignoreRelatedElements)
Optional<String>	getComment()
ReferenceCategory	getReferenceCategory()
String	getReferenceLocator()
ReferenceType	getReferenceType()
String	getType()
ExternalRef	setComment(String comment)
ExternalRef	setReferenceCategory(ReferenceCategory referenceCategory)	Set the reference category
ExternalRef	setReferenceLocator(String referenceLocator)	Set the reference locator
ExternalRef	setReferenceType(ReferenceType referenceType)	Set the reference 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, 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

ExternalRef

public ExternalRef()
            throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

ExternalRef

public ExternalRef(String id)
            throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

ExternalRef

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

Parameters:

modelStore -

documentUri -

id -

create -

copyManager -

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

compareTo

public int compareTo(ExternalRef o)

Specified by:

compareTo in interface Comparable<ExternalRef>

getComment

public Optional<String> getComment()
                            throws InvalidSPDXAnalysisException

Returns:

the comment

Throws:

InvalidSPDXAnalysisException

setComment

public ExternalRef setComment(String comment)
                       throws InvalidSPDXAnalysisException

Parameters:

comment - comment to set

Returns:

this to build additional setters

Throws:

InvalidSPDXAnalysisException

getReferenceCategory

public ReferenceCategory getReferenceCategory()
                                       throws InvalidSPDXAnalysisException

Returns:

the referenceCategory

Throws:

InvalidSPDXAnalysisException

setReferenceCategory

public ExternalRef setReferenceCategory(ReferenceCategory referenceCategory)
                                 throws InvalidSPDXAnalysisException

Set the reference category

Parameters:

referenceCategory -

Returns:

this to build additional setters

Throws:

InvalidSPDXAnalysisException

getReferenceType

public ReferenceType getReferenceType()
                               throws InvalidSPDXAnalysisException

Returns:

the referenceType. If the refrenceType is not in the modelStore, the constant ReferenceType.MISSING is returned

Throws:

InvalidSPDXAnalysisException

setReferenceType

public ExternalRef setReferenceType(ReferenceType referenceType)
                             throws InvalidSPDXAnalysisException

Set the reference type

Parameters:

referenceType -

Returns:

this to build additional setters

Throws:

InvalidSPDXAnalysisException

getReferenceLocator

public String getReferenceLocator()
                           throws InvalidSPDXAnalysisException

Returns:

the referenceLocator. If not found, a blank string is returned

Throws:

InvalidSPDXAnalysisException

setReferenceLocator

public ExternalRef setReferenceLocator(String referenceLocator)
                                throws InvalidSPDXAnalysisException

Set the reference locator

Parameters:

referenceLocator -

Returns:

this to build additional setter

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

toString

public String toString()

Overrides:

toString in class ModelObject