Uses of Class
org.spdx.library.model.SpdxFile

Packages that use SpdxFile

Package	Description
org.spdx.library.model	Copyright (c) 2019 Source Auditor Inc.
org.spdx.utility.compare	Utility classes for comparing SPDX model objects
org.spdx.utility.verificationcode

Uses of SpdxFile in org.spdx.library.model

Methods in org.spdx.library.model that return SpdxFile

Modifier and Type	Method	Description
SpdxFile	SpdxFile.SpdxFileBuilder.build()
SpdxFile	SpdxSnippet.getSnippetFromFile()
SpdxFile	SpdxFile.setCopyrightText(String copyrightText)
SpdxFile	SpdxFile.setLicenseComments(String licenseComments)
SpdxFile	SpdxFile.setLicenseConcluded(AnyLicenseInfo license)
SpdxFile	SpdxFile.setName(String name)
SpdxFile	SpdxFile.setNoticeText(String noticeText)

Methods in org.spdx.library.model that return types with arguments of type SpdxFile

Modifier and Type	Method	Description
Collection<SpdxFile>	SpdxFile.getFileDependency()	Deprecated.
Collection<SpdxFile>	SpdxPackage.getFiles()

Methods in org.spdx.library.model with parameters of type SpdxFile

Modifier and Type	Method	Description
SpdxPackage	SpdxPackage.addFile(SpdxFile file)	Add a file to the collection of files attached to this package
SpdxPackage.SpdxPackageBuilder	SpdxPackage.SpdxPackageBuilder.addFile(SpdxFile file)
int	SpdxFile.compareTo(SpdxFile o)
SpdxSnippet.SpdxSnippetBuilder	ModelObject.createSpdxSnippet(String id, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> seenLicense, String copyrightText, SpdxFile snippetFromFile, int startByte, int endByte)	Create an SpdxSnippetBuilder with all of the required properties - the build() method will build the file
SpdxSnippet	SpdxSnippet.setSnippetFromFile(SpdxFile snippetFromFile)

Method parameters in org.spdx.library.model with type arguments of type SpdxFile

Modifier and Type	Method	Description
SpdxPackage.SpdxPackageBuilder	SpdxPackage.SpdxPackageBuilder.setFiles(Collection<SpdxFile> files)

Constructors in org.spdx.library.model with parameters of type SpdxFile

Constructor	Description
SpdxSnippetBuilder(IModelStore modelStore, String documentUri, String id, ModelCopyManager copyManager, String name, AnyLicenseInfo concludedLicense, Collection<AnyLicenseInfo> licenseInfosFromFile, String copyrightText, SpdxFile snippetFromFile, int startByte, int endByte)	Build a snippet with the required parameters

Uses of SpdxFile in org.spdx.utility.compare

Methods in org.spdx.utility.compare that return SpdxFile

Modifier and Type	Method	Description
SpdxFile	SpdxFileComparer.getFile(SpdxDocument spdxDocument)
SpdxFile	SpdxSnippetComparer.getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB)	Get an SpdxFile that only exists in docA but not docB

Methods in org.spdx.utility.compare that return types with arguments of type SpdxFile

Modifier and Type	Method	Description
List<SpdxFile>	SpdxComparer.collectAllFiles(SpdxDocument spdxDocument)	Collect all of the files present in the SPDX document including files within documents and files embedded in packages
List<SpdxFile>	SpdxComparer.getUniqueFiles(int docindex1, int docindex2)	Return any files which are in spdx document index 1 but not in spdx document index 2
List<SpdxFile>	SpdxPackageComparer.getUniqueFiles(SpdxDocument docA, SpdxDocument docB)	Return any unique files by name which are in docA but not in docB

Methods in org.spdx.utility.compare with parameters of type SpdxFile

Modifier and Type	Method	Description
void	SpdxFileComparer.addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile)	Add a file to the comparer and compare to the existing files

Constructors in org.spdx.utility.compare with parameters of type SpdxFile

Constructor

Description

SpdxFileDifference(SpdxFile fileA, SpdxFile fileB, boolean concludedLicensesEqual, boolean seenLicensesEqual, List<AnyLicenseInfo> uniqueSeenLicensesA, List<AnyLicenseInfo> uniqueSeenLicensesB, boolean checksumsEquals, List<Checksum> uniqueChecksumsA, List<Checksum> uniqueChecksumsB, boolean relationshipsEquals, List<Relationship> uniqueRelationshipA, List<Relationship> uniqueRelationshipB, boolean annotationsEquals, List<Annotation> uniqueAnnotationsA, List<Annotation> uniqueAnnotationsB)

Uses of SpdxFile in org.spdx.utility.verificationcode

Methods in org.spdx.utility.verificationcode with parameters of type SpdxFile

Modifier and Type	Method	Description
SpdxPackageVerificationCode	VerificationCodeGenerator.generatePackageVerificationCode(SpdxFile[] spdxFiles, String[] skippedFilePaths, IModelStore modelStore, String documentUri)	Generate the SPDX Package Verification Code from an array of SPDXFiles