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

Packages that use SpdxDocument

Package	Description
org.spdx.library	Package containing useful library functions for reading, writing, and manipulating SPDX documents.
org.spdx.library.model	Copyright (c) 2019 Source Auditor Inc.
org.spdx.utility.compare	Utility classes for comparing SPDX model objects

Uses of SpdxDocument in org.spdx.library

Methods in org.spdx.library that return SpdxDocument

Modifier and Type	Method	Description
static SpdxDocument	Read.Document.get(IModelStore modelStore, String documentUri)

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

Modifier and Type	Method	Description
static List<SpdxDocument>	Read.Document.get(IModelStore modelStore)	Obtains the SPDX Documents described in the provided model store.

Uses of SpdxDocument in org.spdx.library.model

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

Modifier and Type	Method	Description
static SpdxDocument	SpdxModelFactory.createSpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager)	Create an SPDX document with default values for creator, created, licenseListVersion, data license and specVersion
SpdxDocument	SpdxDocument.setDocumentDescribes(List<SpdxItem> documentDescribes)	clear and reset document describes to the paramater collection
SpdxDocument	SpdxDocument.setExternalDocumentRefs(Collection<ExternalDocumentRef> externalDocumentRefs)	Clear the externalDocumentRefs and add all elements from externalDocumentRefs
SpdxDocument	SpdxDocument.setExtractedLicenseInfos(List<ExtractedLicenseInfo> extractedLicenseInfos)	Clear the extractedLicenseInfos and add all elements from extractedLicenseInfos

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

Modifier and Type	Method	Description
Optional<SpdxDocument>	ExternalDocumentRef.getSpdxDocument()	Returns the SPDX document if it exists within the same model store, otherwise it returns Optional.empty

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

Modifier and Type	Method	Description
ExternalDocumentRef	ExternalDocumentRef.setSpdxDocument(SpdxDocument spdxDocument)

Uses of SpdxDocument in org.spdx.utility.compare

Fields in org.spdx.utility.compare with type parameters of type SpdxDocument

Modifier and Type	Field	Description
protected Map<SpdxDocument,SpdxItem>	SpdxItemComparer.documentItem	Map of SPDX document to Items
protected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>	SpdxItemComparer.extractedLicenseIdMap	Mapping of all extracted license info ID's between all SPDX documents included in the comparer
protected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>	SpdxItemComparer.extractedLicenseIdMap	Mapping of all extracted license info ID's between all SPDX documents included in the comparer

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

Modifier and Type	Method	Description
SpdxDocument	SpdxComparer.getSpdxDoc(int docIndex)

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

Modifier and Type	Method	Description
List<SpdxDocument>	SpdxComparer.getSpdxDocuments()

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

Modifier and Type	Method	Description
void	SpdxFileComparer.addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile)	Add a file to the comparer and compare to the existing files
void	SpdxItemComparer.addDocumentItem(SpdxDocument spdxDocument, SpdxItem spdxItem)	Add a new item to the comparer and compare the contents of the item to all items which have been previously added
void	SpdxPackageComparer.addDocumentPackage(SpdxDocument spdxDocument, SpdxPackage spdxPackage)	Add a package to the comparer and performs the comparison to any existing documents
void	SpdxSnippetComparer.addDocumentSnippet(SpdxDocument spdxDocument, SpdxSnippet snippet)	Add a snippet to the comparer and performs the comparison to any existing documents
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
protected List<SpdxPackage>	SpdxComparer.collectAllPackages(SpdxDocument spdxDocument)	Collect all of the packages present in the SPDX document including packages embedded in other relationships within documents
void	SpdxComparer.compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2)	Compares 2 SPDX documents
SpdxPackage	SpdxPackageComparer.getDocPackage(SpdxDocument document)	Return the package associated with the document
SpdxSnippet	SpdxSnippetComparer.getDocSnippet(SpdxDocument spdxDocument)
List<SpdxExternalRefDifference>	SpdxPackageComparer.getExternalRefDifferences(SpdxDocument docA, SpdxDocument docB)
SpdxFile	SpdxFileComparer.getFile(SpdxDocument spdxDocument)
SpdxFileDifference	SpdxFileComparer.getFileDifference(SpdxDocument docA, SpdxDocument docB)	Return a file difference for the file contained in two different documents
List<SpdxFileDifference>	SpdxPackageComparer.getFileDifferences(SpdxDocument docA, SpdxDocument docB)	Get any fileDifferences which are in docA but not in docB
SpdxItem	SpdxItemComparer.getItem(SpdxDocument doc)	Get the item contained by the document doc
SpdxFileDifference	SpdxSnippetComparer.getSnippetFromFileDifference(SpdxDocument docA, SpdxDocument docB)	Get any file difference for the Spdx Snippet From File between the two SPDX documents If the fileName is different, the they are considered unique files and the getUniqueSnippetFromFile should be called to obtain the unique file
List<Annotation>	SpdxItemComparer.getUniqueAnnotations(SpdxDocument docA, SpdxDocument docB)	Get annotations that are in docA but not in docB
List<Checksum>	SpdxFileComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)	Get the checksums which are present in the file contained document A but not in document B
List<Checksum>	SpdxPackageComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)	Get the checksums which are present in document A but not in document B
List<ExternalRef>	SpdxPackageComparer.getUniqueExternalRefs(SpdxDocument docA, SpdxDocument docB)
List<SpdxFile>	SpdxPackageComparer.getUniqueFiles(SpdxDocument docA, SpdxDocument docB)	Return any unique files by name which are in docA but not in docB
List<Relationship>	SpdxItemComparer.getUniqueRelationship(SpdxDocument docA, SpdxDocument docB)	Get relationships that are in docA but not in docB
List<AnyLicenseInfo>	SpdxItemComparer.getUniqueSeenLicenses(SpdxDocument docA, SpdxDocument docB)	Get any licenses found in docA but not in docB
SpdxFile	SpdxSnippetComparer.getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB)	Get an SpdxFile that only exists in docA but not docB

Method parameters in org.spdx.utility.compare with type arguments of type SpdxDocument

Modifier and Type	Method	Description
void	SpdxComparer.compare(List<SpdxDocument> spdxDocuments)	Compares multiple SPDX documents

Constructor parameters in org.spdx.utility.compare with type arguments of type SpdxDocument

Constructor	Description
SpdxFileComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxFileComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxItemComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxItemComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxPackageComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxPackageComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxSnippetComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)
SpdxSnippetComparer(Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>> extractedLicenseIdMap)