Package org.spdx.library.model.v2

Class SpdxPackageVerificationCode

java.lang.Object

org.spdx.core.CoreModelObject

org.spdx.library.model.v2.ModelObjectV2

org.spdx.library.model.v2.SpdxPackageVerificationCode

public class SpdxPackageVerificationCode
extends ModelObjectV2

Verification Code for packages

Author:

Gary O'Neall

Nested Class Summary

Nested classes/interfaces inherited from class org.spdx.core.CoreModelObject

org.spdx.core.CoreModelObject.CoreModelObjectBuilder

Field Summary

Fields inherited from class org.spdx.library.model.v2.ModelObjectV2

LATEST_SPDX_2_VERSION

Fields inherited from class org.spdx.core.CoreModelObject

copyManager, idPrefix, modelStore, objectUri, specVersion, strict

Constructor Summary

Constructors

Constructor	Description
SpdxPackageVerificationCode()
SpdxPackageVerificationCode(String id)
SpdxPackageVerificationCode(org.spdx.storage.IModelStore modelStore, String documentUri, String id, org.spdx.core.IModelCopyManager 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
Collection<String>	getExcludedFileNames()
String	getType()
String	getValue()
void	setValue(String value)	Set the value for the verification code

Methods inherited from class org.spdx.library.model.v2.ModelObjectV2

_verify, createAnnotation, createByteOffsetPointer, createChecksum, createConjunctiveLicenseSet, createCreationInfo, createCrossRef, createDisjunctiveLicenseSet, createExternalDocumentRef, createExternalRef, createExtractedLicense, createLineCharPointer, createPackage, createPackageVerificationCode, createRelationship, createSpdxFile, createSpdxSnippet, createStartEndPointer, equals, getAnyLicenseInfoPropertyValue, getDocumentUri, getElementPropertyValue, getId, hashCode, isEquivalentToNull, isNoAssertion, isRelatedElement, toString, toTypedValue, verify

Methods inherited from class org.spdx.core.CoreModelObject

addPropertyValueToCollection, clearValueCollection, clone, copyFrom, enterCriticalSection, equivalent, equivalent, getBooleanPropertyValue, getCopyManager, getDoublePropertyValue, getEnumPropertyValue, getIdPrefix, getIntegerPropertyValue, getModelStore, getObjectPropertyValue, getObjectPropertyValue, getObjectPropertyValueCollection, getObjectPropertyValueSet, getObjectUri, getPropertyValueDescriptors, getSpecVersion, getStringCollection, getStringPropertyValue, isCollectionMembersAssignableTo, isExternal, isStrict, leaveCriticalSection, removeProperty, removePropertyValueFromCollection, setCopyManager, setIdPrefix, setPropertyValue, setStrict, updateAddPropertyValueToCollection, updateClearValueCollection, updatePropertyValue, updateRemoveProperty, updateRemovePropertyValueFromCollection, verify, verify, verifyCollection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpdxPackageVerificationCode

public SpdxPackageVerificationCode()
                            throws org.spdx.core.InvalidSPDXAnalysisException

Throws:

org.spdx.core.InvalidSPDXAnalysisException

SpdxPackageVerificationCode

public SpdxPackageVerificationCode(String id)
                            throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

id - identifier

Throws:

org.spdx.core.InvalidSPDXAnalysisException

SpdxPackageVerificationCode

public SpdxPackageVerificationCode(org.spdx.storage.IModelStore modelStore,
                                   String documentUri,
                                   String id,
                                   @Nullable
                                   org.spdx.core.IModelCopyManager copyManager,
                                   boolean create)
                            throws org.spdx.core.InvalidSPDXAnalysisException

Parameters:

modelStore - container which includes the model data

documentUri - URI for the SPDX document containing the model data

id - identifier

copyManager - if non-null, allows for copying of any properties set which use other model stores or document URI's

create - if true, create the license if it does not exist

Throws:

org.spdx.core.InvalidSPDXAnalysisException

Method Detail

getType

public String getType()

Specified by:

getType in class org.spdx.core.CoreModelObject

getValue

public String getValue()
                throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

the value of the verification code

Throws:

org.spdx.core.InvalidSPDXAnalysisException

setValue

public void setValue(String value)
              throws org.spdx.core.InvalidSPDXAnalysisException

Set the value for the verification code

Parameters:

value - verification code value

Throws:

org.spdx.core.InvalidSPDXAnalysisException

getExcludedFileNames

public Collection<String> getExcludedFileNames()
                                        throws org.spdx.core.InvalidSPDXAnalysisException

Returns:

Collection containing files which have been excluded from the verification code calculation

Throws:

org.spdx.core.InvalidSPDXAnalysisException

_verify

protected List<String> _verify(Set<String> verifiedIds,
                               String specVersion)

Description copied from class: ModelObjectV2

Implementation of the specific verifications for this model object

Specified by:

_verify in class ModelObjectV2

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