| Package | Description |
|---|---|
| org.spdx.compare | |
| org.spdx.merge | |
| org.spdx.rdfparser | |
| org.spdx.rdfparser.license |
Classes implementing the license model for the SPDX Parser
|
| org.spdx.rdfparser.model |
Model for the SPDX 2.0+ specification.
|
| org.spdx.spdxspreadsheet |
| Modifier and Type | Method and Description |
|---|---|
AnyLicenseInfo[] |
SpdxItemComparer.getUniqueSeenLicenses(SpdxDocument docA,
SpdxDocument docB)
Get any licenses found in docA but not in docB
|
AnyLicenseInfo[] |
SpdxItemDifference.getUniqueSeenLicensesA() |
AnyLicenseInfo[] |
SpdxItemDifference.getUniqueSeenLicensesB() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
SpdxComparer.compareLicense(int doc1,
AnyLicenseInfo license1,
int doc2,
AnyLicenseInfo license2)
Compares two licenses from two different SPDX documents taking into account
the extracted license infos who's ID's may be different between the two documents
Note: The ExtracedLicenseIDMap must be initialized before this method is invoked
|
static boolean |
LicenseCompareHelper.isLicenseEqual(AnyLicenseInfo license1,
AnyLicenseInfo license2,
Map<String,String> xlationMap)
Compares two licenses from potentially two different documents which may have
different license ID's for the same license
|
static String |
CompareHelper.licenseInfosToString(AnyLicenseInfo[] licenseInfoFromFiles) |
| Constructor and Description |
|---|
SpdxFileDifference(SpdxFile fileA,
SpdxFile fileB,
boolean concludedLicensesEqual,
boolean seenLicensesEqual,
AnyLicenseInfo[] uniqueSeenLicensesA,
AnyLicenseInfo[] uniqueSeenLicensesB,
boolean artifactOfsEquals,
DoapProject[] uniqueArtifactOfA2,
DoapProject[] uniqueArtifactOfB2,
boolean checksumsEquals,
Checksum[] uniqueChecksumsA,
Checksum[] uniqueChecksumsB,
boolean relationshipsEquals,
Relationship[] uniqueRelationshipA,
Relationship[] uniqueRelationshipB,
boolean annotationsEquals,
Annotation[] uniqueAnnotationsA,
Annotation[] uniqueAnnotationsB) |
SpdxFileDifference(SpdxFile fileA,
SpdxFile fileB,
boolean concludedLicensesEqual,
boolean seenLicensesEqual,
AnyLicenseInfo[] uniqueSeenLicensesA,
AnyLicenseInfo[] uniqueSeenLicensesB,
boolean artifactOfsEquals,
DoapProject[] uniqueArtifactOfA2,
DoapProject[] uniqueArtifactOfB2,
boolean checksumsEquals,
Checksum[] uniqueChecksumsA,
Checksum[] uniqueChecksumsB,
boolean relationshipsEquals,
Relationship[] uniqueRelationshipA,
Relationship[] uniqueRelationshipB,
boolean annotationsEquals,
Annotation[] uniqueAnnotationsA,
Annotation[] uniqueAnnotationsB) |
SpdxItemDifference(SpdxItem itemA,
SpdxItem itemB,
boolean concludedLicensesEqual,
boolean seenLicensesEqual,
AnyLicenseInfo[] uniqueSeenLicensesA,
AnyLicenseInfo[] uniqueSeenLicensesB,
boolean relationshipsEquals,
Relationship[] uniqueRelationshipA,
Relationship[] uniqueRelationshipB,
boolean annotationsEquals,
Annotation[] uniqueAnnotationsA,
Annotation[] uniqueAnnotationsB) |
SpdxItemDifference(SpdxItem itemA,
SpdxItem itemB,
boolean concludedLicensesEqual,
boolean seenLicensesEqual,
AnyLicenseInfo[] uniqueSeenLicensesA,
AnyLicenseInfo[] uniqueSeenLicensesB,
boolean relationshipsEquals,
Relationship[] uniqueRelationshipA,
Relationship[] uniqueRelationshipB,
boolean annotationsEquals,
Annotation[] uniqueAnnotationsA,
Annotation[] uniqueAnnotationsB) |
| Modifier and Type | Method and Description |
|---|---|
AnyLicenseInfo[] |
SpdxPackageInfoMerger.checkLicenseFromFile(SpdxDocument doc,
SpdxPackage temp)
A method to check license from file information through mapLicenseInfo function.
|
AnyLicenseInfo |
SpdxPackageInfoMerger.licsCombiner(AnyLicenseInfo lic1,
AnyLicenseInfo lic2)
A method to combine two licenses into one
|
AnyLicenseInfo |
SpdxLicenseMapper.mapLicenseInfo(SpdxDocument spdxDoc,
AnyLicenseInfo license)
a method gets a sub SPDX document and licenses from declared licenses in document package.
|
AnyLicenseInfo |
SpdxLicenseMapper.mapNonStdLicInMap(SpdxDocument spdxDoc,
AnyLicenseInfo license)
a method gets a sub SPDX document and one of its license (non-standard license).
|
| Modifier and Type | Method and Description |
|---|---|
Map<AnyLicenseInfo,AnyLicenseInfo> |
SpdxLicenseMapper.foundInterMap(SpdxDocument spdxDoc) |
Map<AnyLicenseInfo,AnyLicenseInfo> |
SpdxLicenseMapper.foundInterMap(SpdxDocument spdxDoc) |
| Modifier and Type | Method and Description |
|---|---|
AnyLicenseInfo |
SpdxPackageInfoMerger.licsCombiner(AnyLicenseInfo lic1,
AnyLicenseInfo lic2)
A method to combine two licenses into one
|
AnyLicenseInfo |
SpdxLicenseMapper.mapLicenseInfo(SpdxDocument spdxDoc,
AnyLicenseInfo license)
a method gets a sub SPDX document and licenses from declared licenses in document package.
|
AnyLicenseInfo |
SpdxLicenseMapper.mapNonStdLicInMap(SpdxDocument spdxDoc,
AnyLicenseInfo license)
a method gets a sub SPDX document and one of its license (non-standard license).
|
| Modifier and Type | Method and Description |
|---|---|
AnyLicenseInfo |
SPDXPackageInfo.getConcludedLicense()
Deprecated.
|
AnyLicenseInfo |
SPDXFile.getConcludedLicenses()
Deprecated.
|
AnyLicenseInfo |
SPDXDocument.SPDXPackage.getConcludedLicenses()
Deprecated.
|
AnyLicenseInfo |
SPDXDocument.SPDXPackage.getDeclaredLicense()
Deprecated.
|
AnyLicenseInfo |
SPDXPackageInfo.getDeclaredLicenses()
Deprecated.
|
AnyLicenseInfo[] |
SPDXDocument.SPDXPackage.getLicenseInfoFromFiles()
Deprecated.
|
AnyLicenseInfo[] |
SPDXPackageInfo.getLicensesFromFiles()
Deprecated.
|
AnyLicenseInfo[] |
SPDXFile.getSeenLicenses()
Deprecated.
|
static AnyLicenseInfo |
SPDXLicenseInfoFactory.parseSPDXLicenseString(String licenseString)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SPDXPackageInfo.setConcludedLicense(AnyLicenseInfo concludedLicense)
Deprecated.
|
void |
SPDXFile.setConcludedLicenses(AnyLicenseInfo fileLicenses)
Deprecated.
|
void |
SPDXDocument.SPDXPackage.setConcludedLicenses(AnyLicenseInfo detectedLicenses)
Deprecated.
|
void |
SPDXPackageInfo.setDConcludedLicense(AnyLicenseInfo concludedLicense)
Deprecated.
|
void |
SPDXDocument.SPDXPackage.setDeclaredLicense(AnyLicenseInfo declaredLicense)
Deprecated.
|
void |
SPDXPackageInfo.setDeclaredLicenses(AnyLicenseInfo declaredLicenses)
Deprecated.
|
void |
SPDXDocument.SPDXPackage.setLicenseInfoFromFiles(AnyLicenseInfo[] licenseInfo)
Deprecated.
|
void |
SPDXPackageInfo.setLicensesFromFiles(AnyLicenseInfo[] licensesFromFiles)
Deprecated.
|
void |
SPDXFile.setSeenLicenses(AnyLicenseInfo[] seenLicenses)
Deprecated.
|
| Constructor and Description |
|---|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf)
Deprecated.
|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf)
Deprecated.
|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf,
String comment)
Deprecated.
|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf,
String comment)
Deprecated.
|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf,
String comment,
SPDXFile[] fileDependencies,
String[] contributors,
String noticeText)
Deprecated.
|
SPDXFile(String name,
String type,
String sha1,
AnyLicenseInfo concludedLicenses,
AnyLicenseInfo[] seenLicenses,
String licenseComments,
String copyright,
DOAPProject[] artifactOf,
String comment,
SPDXFile[] fileDependencies,
String[] contributors,
String noticeText)
Deprecated.
|
SPDXPackageInfo(String declaredName,
String versionInfo,
String machineName,
String sha1,
String sourceInfo,
AnyLicenseInfo declaredLicense,
AnyLicenseInfo concludedLicense,
AnyLicenseInfo[] licensesFromFiles,
String licenseComments,
String declaredCopyright,
String shortDescription,
String description,
String url,
SpdxPackageVerificationCode spdxPackageVerificationCode,
String supplier,
String originator,
String homePage)
Deprecated.
|
SPDXPackageInfo(String declaredName,
String versionInfo,
String machineName,
String sha1,
String sourceInfo,
AnyLicenseInfo declaredLicense,
AnyLicenseInfo concludedLicense,
AnyLicenseInfo[] licensesFromFiles,
String licenseComments,
String declaredCopyright,
String shortDescription,
String description,
String url,
SpdxPackageVerificationCode spdxPackageVerificationCode,
String supplier,
String originator,
String homePage)
Deprecated.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConjunctiveLicenseSet
A set of licenses where all of the licenses apply
|
class |
DisjunctiveLicenseSet
A set of licenses where there is a choice of one of the licenses in the set
|
class |
ExtractedLicenseInfo
An ExtractedLicensingInfo represents a license or licensing notice that was found in the package.
|
class |
License
Describes a license
All licenses have an ID.
|
class |
LicenseSet
A specific form of license information where there is a set of licenses
represented
|
class |
OrLaterOperator
A license that has an or later operator (e.g.
|
class |
SimpleLicensingInfo
The SimpleLicenseInfo class includes all resources that represent
simple, atomic, licensing information.
|
class |
SpdxListedLicense
Listed license for SPDX as listed at spdx.org/licenses
|
class |
SpdxNoAssertionLicense
Special class of license to represent no asserted license license in the file or packages
|
class |
SpdxNoneLicense
A special license meaning that no license was found
|
class |
WithExceptionOperator
A license that has a With exception operator (e.g.
|
| Modifier and Type | Field and Description |
|---|---|
protected Set<AnyLicenseInfo> |
LicenseSet.licenseInfos |
| Modifier and Type | Method and Description |
|---|---|
AnyLicenseInfo |
WithExceptionOperator.clone() |
AnyLicenseInfo |
SpdxNoneLicense.clone() |
AnyLicenseInfo |
SpdxNoAssertionLicense.clone() |
AnyLicenseInfo |
OrLaterOperator.clone() |
AnyLicenseInfo |
License.clone() |
AnyLicenseInfo |
ExtractedLicenseInfo.clone() |
AnyLicenseInfo |
DisjunctiveLicenseSet.clone() |
AnyLicenseInfo |
ConjunctiveLicenseSet.clone() |
abstract AnyLicenseInfo |
AnyLicenseInfo.clone() |
protected AnyLicenseInfo[] |
DisjunctiveLicenseSet.getFlattenedMembers()
Disjunctive license sets can contain other conjunctive license sets as members.
|
AnyLicenseInfo[] |
ConjunctiveLicenseSet.getFlattenedMembers()
Conjunctive license sets can contain other conjunctive license sets as members.
|
AnyLicenseInfo |
WithExceptionOperator.getLicense() |
AnyLicenseInfo |
ListedLicenses.getLicenseFromStdLicModel(IModelContainer modelContainer,
org.apache.jena.graph.Node node)
Get or create a standard license in the model container copying any
relevant information from the standard model to the model in the modelContainer
|
static AnyLicenseInfo |
LicenseInfoFactory.getLicenseInfoFromModel(IModelContainer modelContainer,
org.apache.jena.graph.Node node)
Create the appropriate SPDXLicenseInfo from the model and node provided.
|
AnyLicenseInfo[] |
LicenseSet.getMembers() |
static AnyLicenseInfo |
LicenseInfoFactory.parseSPDXLicenseString(String licenseString)
Parses a license string and converts it into a SPDXLicenseInfo object
Syntax - A license set must start and end with a parenthesis "("
A conjunctive license set will have and AND after the first
licenseInfo term
A disjunctive license set will have an OR after the first
licenseInfo term
If there is no And or Or, then it is converted to a simple
license type
A space or tab must be used between license ID's and the
keywords AND and OR
A licenseID must NOT be "AND" or "OR"
|
static AnyLicenseInfo |
LicenseInfoFactory.parseSPDXLicenseString(String licenseString,
SpdxDocumentContainer container)
Parses a license string and converts it into a SPDXLicenseInfo object
Syntax - A license set must start and end with a parenthesis "("
A conjunctive license set will have and AND after the first
licenseInfo term
A disjunctive license set will have an OR after the first
licenseInfo term
If there is no And or Or, then it is converted to a simple
license type
A space or tab must be used between license ID's and the
keywords AND and OR
A licenseID must NOT be "AND" or "OR"
|
| Modifier and Type | Method and Description |
|---|---|
void |
WithExceptionOperator.setLicense(AnyLicenseInfo license) |
void |
LicenseSet.setMembers(AnyLicenseInfo[] licenseInfos)
Sets the members of the license set.
|
| Constructor and Description |
|---|
ConjunctiveLicenseSet(AnyLicenseInfo[] conjunctiveLicenses) |
DisjunctiveLicenseSet(AnyLicenseInfo[] disjunctiveLicenses) |
LicenseSet(AnyLicenseInfo[] licenseInfos) |
WithExceptionOperator(AnyLicenseInfo license,
LicenseException exception) |
| Modifier and Type | Method and Description |
|---|---|
protected AnyLicenseInfo |
SpdxItem.cloneLicenseConcluded() |
protected AnyLicenseInfo[] |
SpdxItem.cloneLicenseInfosFromFiles() |
AnyLicenseInfo |
RdfModelObject.findAnyLicenseInfoPropertyValue(String namespace,
String propertyName)
Find a property value with a subject of this object
|
AnyLicenseInfo[] |
RdfModelObject.findAnyLicenseInfoPropertyValues(String namespace,
String propertyName)
Find a property value with a subject of this object
|
AnyLicenseInfo |
SpdxPackage.getConcludedLicenses()
Deprecated.
|
AnyLicenseInfo |
SpdxFile.getConcludedLicenses()
Deprecated.
|
AnyLicenseInfo |
SpdxDocument.getDataLicense() |
AnyLicenseInfo |
SpdxPackage.getDeclaredLicense()
Deprecated.
|
AnyLicenseInfo |
SpdxItem.getLicenseConcluded() |
AnyLicenseInfo |
SpdxPackage.getLicenseDeclared() |
AnyLicenseInfo[] |
SpdxItem.getLicenseInfoFromFiles() |
AnyLicenseInfo[] |
SpdxFile.getSeenLicenses()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
RdfModelObject.addPropertyValue(String nameSpace,
String propertyName,
AnyLicenseInfo license)
Add a property value of type AnyLicenseInfo without removing the existing property values
|
void |
SpdxFile.setConcludedLicenses(AnyLicenseInfo concludedLicense)
Deprecated.
|
void |
SpdxDocument.setDataLicense(AnyLicenseInfo dataLicense) |
void |
SpdxItem.setLicenseConcluded(AnyLicenseInfo licenseConcluded) |
void |
SpdxPackage.setLicenseDeclared(AnyLicenseInfo licenseDeclared) |
void |
SpdxItem.setLicenseInfosFromFiles(AnyLicenseInfo[] licenseInfoFromFiles) |
protected void |
RdfModelObject.setPropertyValue(String nameSpace,
String propertyName,
AnyLicenseInfo license)
Set a property value for this resource.
|
void |
RdfModelObject.setPropertyValues(String nameSpace,
String propertyName,
AnyLicenseInfo[] licenses)
Set a property value for this resource.
|
void |
SpdxFile.setSeenLicenses(AnyLicenseInfo[] seenLicenses)
Deprecated.
|
| Constructor and Description |
|---|
SpdxFile(String fileName,
SpdxFile.FileType[] fileTypes,
String sha1Value,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFiles,
String licenseComment,
String copyrightText,
DoapProject[] artifactOfs,
String fileComment) |
SpdxFile(String fileName,
SpdxFile.FileType[] fileTypes,
String sha1Value,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFiles,
String licenseComment,
String copyrightText,
DoapProject[] artifactOfs,
String fileComment) |
SpdxFile(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFile,
String copyrightText,
String licenseComment,
SpdxFile.FileType[] fileTypes,
Checksum[] checksums,
String[] fileContributors,
String noticeText,
DoapProject[] artifactOf) |
SpdxFile(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFile,
String copyrightText,
String licenseComment,
SpdxFile.FileType[] fileTypes,
Checksum[] checksums,
String[] fileContributors,
String noticeText,
DoapProject[] artifactOf) |
SpdxItem(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoFromFiles,
String copyrightText,
String licenseComment) |
SpdxItem(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoFromFiles,
String copyrightText,
String licenseComment) |
SpdxPackage(String name,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
AnyLicenseInfo licenseDeclared,
String downloadLocation,
SpdxFile[] files,
SpdxPackageVerificationCode packageVerificationCode) |
SpdxPackage(String name,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
AnyLicenseInfo licenseDeclared,
String downloadLocation,
SpdxFile[] files,
SpdxPackageVerificationCode packageVerificationCode) |
SpdxPackage(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
String licenseComment,
AnyLicenseInfo licenseDeclared,
Checksum[] checksums,
String description,
String downloadLocation,
SpdxFile[] files,
String homepage,
String originator,
String packageFileName,
SpdxPackageVerificationCode packageVerificationCode,
String sourceInfo,
String summary,
String supplier,
String versionInfo) |
SpdxPackage(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
String licenseComment,
AnyLicenseInfo licenseDeclared,
Checksum[] checksums,
String description,
String downloadLocation,
SpdxFile[] files,
String homepage,
String originator,
String packageFileName,
SpdxPackageVerificationCode packageVerificationCode,
String sourceInfo,
String summary,
String supplier,
String versionInfo) |
SpdxPackage(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
String licenseComment,
AnyLicenseInfo licenseDeclared,
Checksum[] checksums,
String description,
String downloadLocation,
SpdxFile[] files,
String homepage,
String originator,
String packageFileName,
SpdxPackageVerificationCode packageVerificationCode,
String sourceInfo,
String summary,
String supplier,
String versionInfo,
boolean filesAnalyzed,
ExternalRef[] externalRefs) |
SpdxPackage(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfosFromFiles,
String copyrightText,
String licenseComment,
AnyLicenseInfo licenseDeclared,
Checksum[] checksums,
String description,
String downloadLocation,
SpdxFile[] files,
String homepage,
String originator,
String packageFileName,
SpdxPackageVerificationCode packageVerificationCode,
String sourceInfo,
String summary,
String supplier,
String versionInfo,
boolean filesAnalyzed,
ExternalRef[] externalRefs) |
SpdxSnippet(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFile,
String copyrightText,
String licenseComment,
SpdxFile snippetFromFile,
StartEndPointer byteRange,
StartEndPointer lineRange) |
SpdxSnippet(String name,
String comment,
Annotation[] annotations,
Relationship[] relationships,
AnyLicenseInfo licenseConcluded,
AnyLicenseInfo[] licenseInfoInFile,
String copyrightText,
String licenseComment,
SpdxFile snippetFromFile,
StartEndPointer byteRange,
StartEndPointer lineRange) |
| Modifier and Type | Method and Description |
|---|---|
static String |
PackageInfoSheet.licensesToString(AnyLicenseInfo[] licenses) |
Copyright © 2018 Linux Foundation. All Rights Reserved.