Package org.spdx.library.model

Class Annotation

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.Annotation

All Implemented Interfaces:

Comparable<Annotation>

public class Annotation
extends ModelObject
implements Comparable<Annotation>

An Annotation is a comment on an SpdxItem by an agent.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<String>	_verify(Set<String> verifiedIds, String specVersion)	Implementation of the specific verifications for this model object
int	compareTo(Annotation o)
String	getAnnotationDate()
AnnotationType	getAnnotationType()
String	getAnnotator()
String	getComment()
String	getType()
Annotation	setAnnotationDate(String date)	Set the annotation date
Annotation	setAnnotationType(AnnotationType type)
Annotation	setAnnotator(String annotator)
Annotation	setComment(String comment)	Set the comment

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

addPropertyValueToCollection, addValueToCollection, clearValueCollection, clearValueCollection, clone, copyFrom, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, 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, 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

Annotation

public Annotation() throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

Annotation

public Annotation(String id) throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

Annotation

public Annotation(IModelStore modelStore, String documentUri, String id, @Nullable 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

getAnnotationType

public AnnotationType getAnnotationType() throws InvalidSPDXAnalysisException

Returns:

annotation type

Throws:

InvalidSPDXAnalysisException

setAnnotationType

public Annotation setAnnotationType(AnnotationType type) throws InvalidSPDXAnalysisException

Parameters:

type -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getAnnotator

public String getAnnotator() throws InvalidSPDXAnalysisException

Returns:

the annotator

Throws:

InvalidSPDXAnalysisException

setAnnotator

public Annotation setAnnotator(String annotator) throws InvalidSPDXAnalysisException

Parameters:

annotator -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getComment

public String getComment() throws InvalidSPDXAnalysisException

Returns:

the comment

Throws:

InvalidSPDXAnalysisException

setComment

public Annotation setComment(String comment) throws InvalidSPDXAnalysisException

Set the comment

Parameters:

comment -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

getAnnotationDate

public String getAnnotationDate() throws InvalidSPDXAnalysisException

Returns:

the date

Throws:

InvalidSPDXAnalysisException

setAnnotationDate

public Annotation setAnnotationDate(String date) throws InvalidSPDXAnalysisException

Set the annotation date

Parameters:

date -

Returns:

this to chain setters

Throws:

InvalidSPDXAnalysisException

_verify

public 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(Annotation o)

Specified by:

compareTo in interface Comparable<Annotation>