Package org.spdx.library.model

Class Checksum

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.Checksum

All Implemented Interfaces:

Comparable<Checksum>

public class Checksum
extends ModelObject
implements Comparable<Checksum>

A Checksum is value that allows the contents of a file to be authenticated. Even small changes to the content of the file will change its checksum. This class allows the results of a variety of checksum and cryptographic message digest algorithms to be represented.

Author:

Gary O'Neall

Field Summary

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

strict

Constructor Summary

Constructors

Constructor	Description
Checksum()
Checksum(String id)
Checksum(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(Checksum compare)
static Checksum	create(IModelStore modelStore, String documentUri, ChecksumAlgorithm algorithm, String value)	Create a checksum with an anonymous ID
ChecksumAlgorithm	getAlgorithm()
String	getType()
String	getValue()
protected void	setAlgorithm(ChecksumAlgorithm algorithm)	Set the checksum algorithm.
protected void	setValue(String value)	Set the value - this should only be called by factory methods
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

Checksum

public Checksum()
         throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

Checksum

public Checksum(String id)
         throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

Checksum

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

Method Details

create

public static Checksum create(IModelStore modelStore,
 String documentUri,
 ChecksumAlgorithm algorithm,
 String value)
                       throws InvalidSPDXAnalysisException

Create a checksum with an anonymous ID

Parameters:

modelStore -

documentUri -

algorithm -

value -

Returns:

Throws:

InvalidSPDXAnalysisException

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

getAlgorithm

public ChecksumAlgorithm getAlgorithm()
                               throws InvalidSPDXAnalysisException

Returns:

the ChecksumAlgorithm MISSING denotes that there was no algorithm stored

Throws:

InvalidSPDXAnalysisException

setAlgorithm

protected void setAlgorithm(ChecksumAlgorithm algorithm)
                     throws InvalidSPDXAnalysisException

Set the checksum algorithm. This should only be called by factory classes since they should not be modified once created and stored.

Parameters:

algorithm -

Throws:

InvalidSPDXAnalysisException

getValue

public String getValue()
                throws InvalidSPDXAnalysisException

Returns:

the checksum algorithm or an empty string if no algorithm value was stored

Throws:

InvalidSPDXAnalysisException

setValue

protected void setValue(String value)
                 throws InvalidSPDXAnalysisException

Set the value - this should only be called by factory methods

Parameters:

value -

Throws:

InvalidSPDXAnalysisException

toString

public String toString()

Overrides:

toString in class ModelObject

compareTo

public int compareTo(Checksum compare)

Specified by:

compareTo in interface Comparable<Checksum>