Package org.spdx.library.model

Class SpdxFile

java.lang.Object

org.spdx.library.model.ModelObject

org.spdx.library.model.SpdxElement

org.spdx.library.model.SpdxItem

org.spdx.library.model.SpdxFile

All Implemented Interfaces:

Comparable<SpdxFile>

public class SpdxFile
extends SpdxItem
implements Comparable<SpdxFile>

A File represents a named sequence of information that is contained in a software package.

Author:

Gary O'Neall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpdxFile.SpdxFileBuilder

Field Summary

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

strict

Constructor Summary

Constructors

Modifier	Constructor	Description
	SpdxFile()
	SpdxFile(String id)
protected	SpdxFile(SpdxFile.SpdxFileBuilder spdxFileBuilder)
	SpdxFile(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
boolean	addChecksum(Checksum checksum)	Add a checksum
boolean	addFileContributor(String contributor)	Add a file contributor to the file contributors collection
boolean	addFileType(FileType fileType)	Add a file type to this file
int	compareTo(SpdxFile o)
Collection<Checksum>	getChecksums()
Collection<String>	getFileContributors()
Collection<SpdxFile>	getFileDependency()	Deprecated.
Collection<FileType>	getFileTypes()
protected String	getLicenseInfoFromFilesPropertyName()
protected String	getNamePropertyName()
Optional<String>	getNoticeText()
String	getSha1()
String	getType()
SpdxFile	setCopyrightText(String copyrightText)
SpdxFile	setLicenseComments(String licenseComments)
SpdxFile	setLicenseConcluded(AnyLicenseInfo license)	Set the licenseConcluded
SpdxFile	setName(String name)	Set the name
SpdxFile	setNoticeText(String noticeText)

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

getAttributionText, getCopyrightText, getLicenseComments, getLicenseConcluded, getLicenseInfoFromFiles

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, 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, 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

SpdxFile

public SpdxFile()
         throws InvalidSPDXAnalysisException

Throws:

InvalidSPDXAnalysisException

SpdxFile

public SpdxFile(String id)
         throws InvalidSPDXAnalysisException

Parameters:

id -

Throws:

InvalidSPDXAnalysisException

SpdxFile

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

Parameters:

modelStore -

documentUri -

id -

create -

Throws:

InvalidSPDXAnalysisException

SpdxFile

protected SpdxFile(SpdxFile.SpdxFileBuilder spdxFileBuilder)
            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

getSha1

public String getSha1()
               throws InvalidSPDXAnalysisException

Returns:

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

Throws:

InvalidSPDXAnalysisException

setCopyrightText

public SpdxFile setCopyrightText(@Nullable
 String copyrightText)
                          throws InvalidSPDXAnalysisException

Overrides:

setCopyrightText in class SpdxItem

Parameters:

copyrightText - the copyrightText to set

Returns:

myself - so you can chain setters

Throws:

InvalidSPDXAnalysisException

setName

public SpdxFile setName(@Nullable
 String name)
                 throws InvalidSPDXAnalysisException

Description copied from class: SpdxElement

Set the name

Overrides:

setName in class SpdxItem

Returns:

this so that you can chain setters

Throws:

InvalidSPDXAnalysisException

setLicenseConcluded

public SpdxFile setLicenseConcluded(@Nullable
 AnyLicenseInfo license)
                             throws InvalidSPDXAnalysisException

Description copied from class: SpdxItem

Set the licenseConcluded

Overrides:

setLicenseConcluded in class SpdxItem

Returns:

this so you can chain setters

Throws:

InvalidSPDXAnalysisException

setLicenseComments

public SpdxFile setLicenseComments(String licenseComments)
                            throws InvalidSPDXAnalysisException

Overrides:

setLicenseComments in class SpdxItem

Parameters:

licenseComments - the licenseComment to set

Returns:

this so you chan chain setters

Throws:

InvalidSPDXAnalysisException

getLicenseInfoFromFilesPropertyName

protected String getLicenseInfoFromFilesPropertyName()

Overrides:

getLicenseInfoFromFilesPropertyName in class SpdxItem

Returns:

Property name for licenseInfoFromFiles. Override if using a subproperty of "licenseDeclared".

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

getFileTypes

public Collection<FileType> getFileTypes()
                                  throws InvalidSPDXAnalysisException

Returns:

File types for the file

Throws:

InvalidSPDXAnalysisException

addFileType

public boolean addFileType(FileType fileType)
                    throws InvalidSPDXAnalysisException

Add a file type to this file

Parameters:

fileType -

Returns:

true if the list was modified

Throws:

InvalidSPDXAnalysisException

getChecksums

public Collection<Checksum> getChecksums()

Returns:

the checksums

addChecksum

public boolean addChecksum(Checksum checksum)
                    throws InvalidSPDXAnalysisException

Add a checksum

Parameters:

checksum -

Returns:

true if the list was modified

Throws:

InvalidSPDXAnalysisException

getFileContributors

public Collection<String> getFileContributors()

Returns:

the fileContributors

addFileContributor

public boolean addFileContributor(String contributor)

Add a file contributor to the file contributors collection

Parameters:

contributor -

Returns:

getNoticeText

public Optional<String> getNoticeText()
                               throws InvalidSPDXAnalysisException

Returns:

the noticeText

Throws:

InvalidSPDXAnalysisException

setNoticeText

public SpdxFile setNoticeText(@Nullable
 String noticeText)
                       throws InvalidSPDXAnalysisException

Parameters:

noticeText - the noticeText to set

Returns:

this so you can chain setters

Throws:

InvalidSPDXAnalysisException

getFileDependency

@Deprecated
public Collection<SpdxFile> getFileDependency()
                                       throws InvalidSPDXAnalysisException

Deprecated.

Returns:

file dependencies - note: this is deprecated, use relationships between files rather than this field

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(SpdxFile o)

Specified by:

compareTo in interface Comparable<SpdxFile>