Package org.spdx.library.model

Class SpdxPackage

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxItem

org.spdx.library.model.SpdxPackage

All Implemented Interfaces:

Comparable<SpdxPackage>

public class SpdxPackage
extends SpdxItem
implements Comparable<SpdxPackage>

A Package represents a collection of software files that are delivered as a single functional component.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpdxPackage.SpdxPackageBuilder

Field Summary

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

strict

Constructor Summary

Constructors

Modifier	Constructor	Description
	SpdxPackage()
	SpdxPackage(String id)
protected	SpdxPackage(SpdxPackage.SpdxPackageBuilder spdxPackageBuilder)
	SpdxPackage(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
SpdxPackage	addChecksum(Checksum checksum)	Add a checksum to the collection of checksums for this package
SpdxPackage	addExternalRef(ExternalRef externalRef)
SpdxPackage	addFile(SpdxFile file)	Add a file to the collection of files attached to this package
int	compareTo(SpdxPackage pkg)
Optional<String>	getBuiltDate()
Collection<Checksum>	getChecksums()
Optional<String>	getDescription()
Optional<String>	getDownloadLocation()
Collection<ExternalRef>	getExternalRefs()
Collection<SpdxFile>	getFiles()
Optional<String>	getHomepage()
AnyLicenseInfo	getLicenseDeclared()
protected String	getNamePropertyName()
Optional<String>	getOriginator()
Optional<String>	getPackageFileName()
Optional<SpdxPackageVerificationCode>	getPackageVerificationCode()
Optional<Purpose>	getPrimaryPurpose()
Optional<String>	getReleaseDate()
String	getSha1()
Optional<String>	getSourceInfo()
Optional<String>	getSummary()
Optional<String>	getSupplier()
String	getType()
Optional<String>	getValidUntilDate()
Optional<String>	getVersionInfo()
boolean	isFilesAnalyzed()
void	setBuiltDate(String builtDate)
SpdxPackage	setDescription(String description)
SpdxPackage	setDownloadLocation(String downloadLocation)
SpdxPackage	setFilesAnalyzed(Boolean filesAnalyzed)	Set files Analyzed for the package
SpdxPackage	setHomepage(String homepage)
SpdxPackage	setLicenseDeclared(AnyLicenseInfo licenseDeclared)	Set the licenseDeclared
SpdxPackage	setOriginator(String originator)
SpdxPackage	setPackageFileName(String packageFileName)
SpdxPackage	setPackageVerificationCode(SpdxPackageVerificationCode verificationCode)
void	setPrimaryPurpose(Purpose purpose)
void	setReleaseDate(String releaseDate)
SpdxPackage	setSourceInfo(String sourceInfo)
SpdxPackage	setSummary(String summary)
SpdxPackage	setSupplier(String supplier)
void	setValidUntilDate(String validUntilDate)
SpdxPackage	setVersionInfo(String versionInfo)

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

getAttributionText, getCopyrightText, getLicenseComments, getLicenseConcluded, getLicenseInfoFromFiles, getLicenseInfoFromFilesPropertyName, setCopyrightText, setLicenseComments, setLicenseConcluded, setName

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

addAnnotation, addNameToWarnings, addRelationship, getAnnotations, getComment, getName, getRelationships, removeAnnotation, removeRelationship, setAnnotations, setComment, setRelationships

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

SpdxPackage

public SpdxPackage() throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxPackage

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

Parameters:

modelStore -

documentUri -

id -

copyManager -

create -

Throws:

InvalidSPDXAnalysisException

SpdxPackage

public SpdxPackage(String id) throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SpdxPackage

protected SpdxPackage(SpdxPackage.SpdxPackageBuilder spdxPackageBuilder) throws InvalidSPDXAnalysisException

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

getNamePropertyName

protected String getNamePropertyName()

Overrides:

getNamePropertyName in class SpdxElement

Returns:

the property name used for the Name property. Override this function if using a subproperty of SPDX Name

isFilesAnalyzed

public boolean isFilesAnalyzed() throws InvalidSPDXAnalysisException

Returns:

true unless the filesAnalyzed property is present and set to false (default is true)

Throws:

InvalidSPDXAnalysisException

setFilesAnalyzed

public SpdxPackage setFilesAnalyzed(@Nullable Boolean filesAnalyzed) throws InvalidSPDXAnalysisException

Set files Analyzed for the package

Parameters:

filesAnalyzed -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getBuiltDate

public Optional<String> getBuiltDate() throws InvalidSPDXAnalysisException

Returns:

This field provides a place for recording the actual date the package was built.

Throws:

InvalidSPDXAnalysisException

setBuiltDate

public void setBuiltDate(String builtDate) throws InvalidSPDXAnalysisException

Parameters:

builtDate - This field provides a place for recording the actual date the package was built.

Throws:

InvalidSPDXAnalysisException

getReleaseDate

public Optional<String> getReleaseDate() throws InvalidSPDXAnalysisException

Returns:

This field provides a place for recording the date the package was released.

Throws:

InvalidSPDXAnalysisException

setReleaseDate

public void setReleaseDate(String releaseDate) throws InvalidSPDXAnalysisException

Parameters:

releaseDate - This field provides a place for recording the date the package was released.

Throws:

InvalidSPDXAnalysisException

getValidUntilDate

public Optional<String> getValidUntilDate() throws InvalidSPDXAnalysisException

Returns:

This field provides a place for recording the end of the support period for a package from the supplier.

Throws:

InvalidSPDXAnalysisException

setValidUntilDate

public void setValidUntilDate(String validUntilDate) throws InvalidSPDXAnalysisException

Parameters:

validUntilDate - This field provides a place for recording the end of the support period for a package from the supplier.

Throws:

InvalidSPDXAnalysisException

getLicenseDeclared

@Nullable public AnyLicenseInfo getLicenseDeclared() throws InvalidSPDXAnalysisException

Returns:

the licenseDeclared or NOASSERTION if no license declared is found

Throws:

InvalidSPDXAnalysisException

setLicenseDeclared

public SpdxPackage setLicenseDeclared(@Nullable AnyLicenseInfo licenseDeclared) throws InvalidSPDXAnalysisException

Set the licenseDeclared

Parameters:

licenseDeclared -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getChecksums

public Collection<Checksum> getChecksums() throws InvalidSPDXAnalysisException

Returns:

collection of checksums

Throws:

InvalidSPDXAnalysisException

addChecksum

public SpdxPackage addChecksum(Checksum checksum) throws InvalidSPDXAnalysisException

Add a checksum to the collection of checksums for this package

Parameters:

checksum -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getDescription

public Optional<String> getDescription() throws InvalidSPDXAnalysisException

Returns:

the description

Throws:

InvalidSPDXAnalysisException

setDescription

public SpdxPackage setDescription(String description) throws InvalidSPDXAnalysisException

Parameters:

description -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getDownloadLocation

public Optional<String> getDownloadLocation() throws InvalidSPDXAnalysisException

Returns:

the downloadLocation

Throws:

InvalidSPDXAnalysisException

setDownloadLocation

public SpdxPackage setDownloadLocation(String downloadLocation) throws InvalidSPDXAnalysisException

Parameters:

downloadLocation - the download location

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getHomepage

public Optional<String> getHomepage() throws InvalidSPDXAnalysisException

Returns:

the homepage

Throws:

InvalidSPDXAnalysisException

setHomepage

public SpdxPackage setHomepage(String homepage) throws InvalidSPDXAnalysisException

Parameters:

homepage - the package homepage

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getOriginator

public Optional<String> getOriginator() throws InvalidSPDXAnalysisException

Returns:

the originator

Throws:

InvalidSPDXAnalysisException

setOriginator

public SpdxPackage setOriginator(String originator) throws InvalidSPDXAnalysisException

Parameters:

originator - the package originator

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getPackageFileName

public Optional<String> getPackageFileName() throws InvalidSPDXAnalysisException

Returns:

the packageFileName

Throws:

InvalidSPDXAnalysisException

setPackageFileName

public SpdxPackage setPackageFileName(String packageFileName) throws InvalidSPDXAnalysisException

Parameters:

packageFileName - the package filename to set

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getPackageVerificationCode

public Optional<SpdxPackageVerificationCode> getPackageVerificationCode() throws InvalidSPDXAnalysisException

Returns:

the packageVerificationCode, null if not present

Throws:

InvalidSPDXAnalysisException

setPackageVerificationCode

public SpdxPackage setPackageVerificationCode(SpdxPackageVerificationCode verificationCode) throws InvalidSPDXAnalysisException

Parameters:

verificationCode - the package verification code to set

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getSourceInfo

public Optional<String> getSourceInfo() throws InvalidSPDXAnalysisException

Returns:

the sourceInfo

Throws:

InvalidSPDXAnalysisException

setSourceInfo

public SpdxPackage setSourceInfo(String sourceInfo) throws InvalidSPDXAnalysisException

Parameters:

sourceInfo - package source info

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getSummary

public Optional<String> getSummary() throws InvalidSPDXAnalysisException

Returns:

the summary

Throws:

InvalidSPDXAnalysisException

setSummary

public SpdxPackage setSummary(String summary) throws InvalidSPDXAnalysisException

Parameters:

summary - package summary

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getSupplier

public Optional<String> getSupplier() throws InvalidSPDXAnalysisException

Returns:

the supplier

Throws:

InvalidSPDXAnalysisException

setSupplier

public SpdxPackage setSupplier(String supplier) throws InvalidSPDXAnalysisException

Parameters:

supplier - the package supplier to set

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getVersionInfo

public Optional<String> getVersionInfo() throws InvalidSPDXAnalysisException

Returns:

the versionInfo

Throws:

InvalidSPDXAnalysisException

setVersionInfo

public SpdxPackage setVersionInfo(String versionInfo) throws InvalidSPDXAnalysisException

Parameters:

versionInfo -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getExternalRefs

public Collection<ExternalRef> getExternalRefs() throws InvalidSPDXAnalysisException

Returns:

the externalRefs

Throws:

InvalidSPDXAnalysisException

addExternalRef

public SpdxPackage addExternalRef(ExternalRef externalRef) throws InvalidSPDXAnalysisException

Parameters:

externalRef -

Throws:

InvalidSPDXAnalysisException

getFiles

public Collection<SpdxFile> getFiles() throws InvalidSPDXAnalysisException

Returns:

the files

Throws:

InvalidSPDXAnalysisException

addFile

public SpdxPackage addFile(SpdxFile file) throws InvalidSPDXAnalysisException

Add a file to the collection of files attached to this package

Parameters:

file -

Returns:

this to build additional options

Throws:

InvalidSPDXAnalysisException

getPrimaryPurpose

public Optional<Purpose> getPrimaryPurpose() throws InvalidSPDXAnalysisException

Returns:

provides information about the primary purpose of the package. Package Purpose is intrinsic to how the package is being used rather than the content of the package.

Throws:

InvalidSPDXAnalysisException

setPrimaryPurpose

public void setPrimaryPurpose(Purpose purpose) throws InvalidSPDXAnalysisException

Parameters:

purpose - provides information about the primary purpose of the package. Package Purpose is intrinsic to how the package is being used rather than the content of the package.

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

Overrides:

_verify in class SpdxItem

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(SpdxPackage pkg)

Specified by:

compareTo in interface Comparable<SpdxPackage>

getSha1

public String getSha1() throws InvalidSPDXAnalysisException

Returns:

the Sha1 checksum value for this package, or a blank string if no sha1 checksum has been set

Throws:

InvalidSPDXAnalysisException