Uses of Class
org.spdx.library.model.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 SpdxDocumentRead.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 SpdxDocumentSpdxModelFactory. createSpdxDocument(IModelStore modelStore, String documentUri, ModelCopyManager copyManager)Create an SPDX document with default values for creator, created, licenseListVersion, data license and specVersionSpdxDocumentSpdxDocument. setDocumentDescribes(List<SpdxItem> documentDescribes)clear and reset document describes to the paramater collectionSpdxDocumentSpdxDocument. setExternalDocumentRefs(Collection<ExternalDocumentRef> externalDocumentRefs)Clear the externalDocumentRefs and add all elements from externalDocumentRefsSpdxDocumentSpdxDocument. setExtractedLicenseInfos(List<ExtractedLicenseInfo> extractedLicenseInfos)Clear the extractedLicenseInfos and add all elements from extractedLicenseInfosMethods 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.emptyMethods in org.spdx.library.model with parameters of type SpdxDocument Modifier and Type Method Description ExternalDocumentRefExternalDocumentRef. 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. documentItemMap of SPDX document to Itemsprotected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>SpdxItemComparer. extractedLicenseIdMapMapping of all extracted license info ID's between all SPDX documents included in the comparerprotected Map<SpdxDocument,Map<SpdxDocument,Map<String,String>>>SpdxItemComparer. extractedLicenseIdMapMapping of all extracted license info ID's between all SPDX documents included in the comparerMethods in org.spdx.utility.compare that return SpdxDocument Modifier and Type Method Description SpdxDocumentSpdxComparer. 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 voidSpdxFileComparer. addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile)Add a file to the comparer and compare to the existing filesvoidSpdxItemComparer. 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 addedvoidSpdxPackageComparer. addDocumentPackage(SpdxDocument spdxDocument, SpdxPackage spdxPackage)Add a package to the comparer and performs the comparison to any existing documentsvoidSpdxSnippetComparer. addDocumentSnippet(SpdxDocument spdxDocument, SpdxSnippet snippet)Add a snippet to the comparer and performs the comparison to any existing documentsList<SpdxFile>SpdxComparer. collectAllFiles(SpdxDocument spdxDocument)Collect all of the files present in the SPDX document including files within documents and files embedded in packagesprotected List<SpdxPackage>SpdxComparer. collectAllPackages(SpdxDocument spdxDocument)Collect all of the packages present in the SPDX document including packages embedded in other relationships within documentsvoidSpdxComparer. compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2)Compares 2 SPDX documentsSpdxPackageSpdxPackageComparer. getDocPackage(SpdxDocument document)Return the package associated with the documentSpdxSnippetSpdxSnippetComparer. getDocSnippet(SpdxDocument spdxDocument)List<SpdxExternalRefDifference>SpdxPackageComparer. getExternalRefDifferences(SpdxDocument docA, SpdxDocument docB)SpdxFileSpdxFileComparer. getFile(SpdxDocument spdxDocument)SpdxFileDifferenceSpdxFileComparer. getFileDifference(SpdxDocument docA, SpdxDocument docB)Return a file difference for the file contained in two different documentsList<SpdxFileDifference>SpdxPackageComparer. getFileDifferences(SpdxDocument docA, SpdxDocument docB)Get any fileDifferences which are in docA but not in docBSpdxItemSpdxItemComparer. getItem(SpdxDocument doc)Get the item contained by the document docSpdxFileDifferenceSpdxSnippetComparer. 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 fileList<Annotation>SpdxItemComparer. getUniqueAnnotations(SpdxDocument docA, SpdxDocument docB)Get annotations that are in docA but not in docBList<Checksum>SpdxFileComparer. getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)Get the checksums which are present in the file contained document A but not in document BList<Checksum>SpdxPackageComparer. getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)Get the checksums which are present in document A but not in document BList<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 docBList<Relationship>SpdxItemComparer. getUniqueRelationship(SpdxDocument docA, SpdxDocument docB)Get relationships that are in docA but not in docBList<AnyLicenseInfo>SpdxItemComparer. getUniqueSeenLicenses(SpdxDocument docA, SpdxDocument docB)Get any licenses found in docA but not in docBSpdxFileSpdxSnippetComparer. getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB)Get an SpdxFile that only exists in docA but not docBMethod parameters in org.spdx.utility.compare with type arguments of type SpdxDocument Modifier and Type Method Description voidSpdxComparer. compare(List<SpdxDocument> spdxDocuments)Compares multiple SPDX documentsConstructor 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)