Package org.spdx.library.model.pointer

Class SinglePointer

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.pointer.SinglePointer

All Implemented Interfaces:

Comparable<SinglePointer>

Direct Known Subclasses:

ByteOffsetPointer, LineCharPointer

public abstract class SinglePointer
extends ModelObject
implements Comparable<SinglePointer>

A pointing method made up of a unique pointer. This is an abstract single pointer that provides the necessary framework, but it does not provide any kind of pointer, so more specific subclasses must be used. See http://www.w3.org/2009/pointers and https://www.w3.org/WAI/ER/Pointers/WD-Pointers-in-RDF10-20110427

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
SinglePointer()
SinglePointer(String id)
SinglePointer(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
protected int	compareReferences(SinglePointer o)
SpdxElement	getReference()
void	setReference(SpdxElement reference)

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Details

SinglePointer

public SinglePointer()
              throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SinglePointer

public SinglePointer(String id)
              throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SinglePointer

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

getReference

@Nullable
public SpdxElement getReference()
                         throws InvalidSPDXAnalysisException

Returns:

the reference, null if no reference is stored

Throws:

InvalidSPDXAnalysisException

setReference

public void setReference(SpdxElement reference)
                  throws InvalidSPDXAnalysisException

Parameters:

reference - the reference to set

Throws:

InvalidSPDXAnalysisException

_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

compareReferences

protected int compareReferences(SinglePointer o)