All Classes
| Class | Description |
|---|---|
| Annotation |
An Annotation is a comment on an SpdxItem by an agent.
|
| AnnotationType |
Annotation types for the Annotation Class
|
| AnyLicenseInfo |
This abstract class represents several ways of describing licensing information.
|
| ByteOffsetPointer |
Byte offset pointer per RDF 2.3.2.2 ByteOffsetPointer Class
|
| Checksum |
A Checksum is value that allows the contents of a file to be authenticated.
|
| ChecksumAlgorithm |
Enum constants for Checksum Algorithms
|
| CompareTemplateOutputHandler |
Compares the output of a parsed license template to text.
|
| CompoundPointer |
A pointing method made up of a pair of pointers that identify a well defined section within a document delimited by a begin and an end.
|
| ConjunctiveLicenseSet |
A set of licenses where all of the licenses apply
|
| CrossRef |
Cross reference details for the a URL reference
|
| CrossRef.CrossRefBuilder | |
| DefaultModelStore | |
| DisjunctiveLicenseSet |
A set of licenses where there is a choice of one of the licenses in the set
|
| DuplicateSpdxIdException | |
| ExceptionJson |
Simple POJO to hold the license exception data loaded from a JSON file
Licenses in the JSON format can be found at spdx.org/licenses/[exceptionid].json
|
| ExceptionJsonTOC |
Table of Contents for the listed license list as represented as a JSON index file
at spdx.org/licenses/licenses.json
|
| ExtendedSpdxStore |
A simple abstract SPDX store that stores everything in an underlying model store which is initialized in the
constructor.
|
| ExternalDocumentRef |
Information about an external SPDX document reference including the checksum.
|
| ExternalExtractedLicenseInfo | |
| ExternalRef |
An External Reference allows a Package to reference an external source of
additional information, metadata, enumerations, asset identifiers, or downloadable content believed to
be relevant to the Package.
|
| ExternalSpdxElement |
This is an SPDX element which is in an external document.
|
| ExtractedLicenseInfo |
An ExtractedLicensingInfo represents a license or licensing notice that was found in the package.
|
| FileType |
File Type is intrinsic to the file, independent of how the file is being used.
|
| FilterTemplateOutputHandler |
Filter the template output to create a list of strings filtering out optional and/or var text
|
| GenericModelObject |
Primarily used for testing, this model object does not implement any unique getters and setters nor
does it implement any verification.
|
| GenericSpdxElement |
Generic SPDX element - primarily used for testing
|
| GenericSpdxItem |
Generic SPDX item - primarily used for testing
|
| HtmlTemplateOutputHandler |
License template output handler for generating an HTML version of a license from a license template.
|
| IFileChecksumGenerator |
Interface for implementations of generators of file checksums
|
| ILicenseTemplateOutputHandler |
Handles output for parsed license templates.
|
| IListedLicenseStore | |
| IModelStore |
Service Provider Interface for storing and retrieving SPDX properties for SPDX documents.
|
| IModelStore.IdType |
Different types of ID's
|
| IModelStore.IModelStoreLock | |
| IModelStore.ModelUpdate | |
| IndividualUriValue |
Classes which implement the IndividuallUriValue interface will be stored as a single value.
|
| InMemSpdxStore | |
| InvalidLicenseStringException | |
| InvalidLicenseTemplateException |
Exceptions related to invalid license templates
|
| InvalidSPDXAnalysisException | |
| InvalidSpdxPropertyException | |
| ISerializableModelStore |
A model store that can be serialized and de-serialized to and from a
Stream |
| JavaSha1ChecksumGenerator |
Java sha1 checksum generator using MessageDigest
|
| License |
Describes a license
All licenses have an ID.
|
| LicenseCompareHelper |
Primarily a static class of helper functions for comparing two SPDX licenses
|
| LicenseException |
Represents an SPDX license exception as defined in the License Expression Language
Used with the "with" unary expression.
|
| LicenseExpressionParser |
A parser for the SPDX License Expressions as documented in the SPDX appendix.
|
| LicenseInfoFactory |
Factory for creating SPDXLicenseInfo objects from a Jena model
|
| LicenseJson |
Simple POJO to hold the license data loaded from a JSON file
Licenses in the JSON format can be found at spdx.org/licenses/[licenseid].json
|
| LicenseJsonTOC |
Table of Contents for the listed license list as represented as a JSON index file
at spdx.org/licenses/licenses.json
|
| LicenseParserException | |
| LicenseParserException |
Exception caused by an invalid license expression
|
| LicenseSet |
A specific form of license information where there is a set of licenses
represented
|
| LicenseTemplateRule |
Implements a license rule
|
| LicenseTemplateRule.RuleType | |
| LicenseTemplateRuleException |
Exception for license template rules
|
| LineCharPointer | |
| LineColumn |
Holds information on lines and columns
|
| ListedLicenseException |
Represents a License Exception present on the SPDX License List
|
| ListedLicenses |
Singleton class which holds the listed licenses
|
| ListedReferenceTypes |
Singleton class that maintains the current SPDX listed reference types.
|
| ModelCollection<T> |
Collection of elements stored in a ModelStore
|
| ModelCopyManager |
This class helps facilitate copying objects from one model to another.
|
| ModelObject | |
| ModelSet<T> |
A ModelCollection implemented as a set where all items in the collection are unique based
on equality (not based on equivalence).
|
| ModelStorageClassConverter |
This static helper class converts objects used in the model to and from objects used by the SPI / storage class.
|
| OrLaterOperator |
A license that has an or later operator (e.g.
|
| Read |
Supports reading SPDX documents from an existing ModelStore
Some design and some implementation borrowed from Yevster's spdxtra project under the Apache 2.0 license
http://yevster.github.io/spdxtra/
|
| Read.Document | |
| ReferenceCategory |
Reference category for external refs
|
| ReferenceType |
Type of external reference
Note that there are very few required fields for this class in that
the external reference type does not need to be provided in the SPDX
document for the document to be valid.
|
| RelatedElementCollection | |
| Relationship |
A Relationship represents a relationship between two SpdxElements.
|
| RelationshipType |
Relationship types
|
| SimpleLicensingInfo |
The SimpleLicenseInfo class includes all resources that represent
simple, atomic, licensing information.
|
| SimpleUriValue |
Simple class to just store a URI value.
|
| SinglePointer |
A pointing method made up of a unique pointer.
|
| SpdxCompareException | |
| SpdxComparer |
Performs a comparison between two or more SPDX documents and holds the results of the comparison
The main function to perform the comparison is
compare(spdxdoc1, spdxdoc2)
For files, the comparison results are separated into unique files based on the file names
which can be obtained by the method getUniqueFiles(index1, index2). |
| SpdxConstantElement |
Type of SpdxElement which is a constant unmodifiable element
|
| SpdxConstants |
Constants which map to the SPDX specifications found at http://spdx.org/rdf/terms
|
| SpdxCreatorInformation | |
| SpdxDocument |
An SpdxDocument is a summary of the contents, provenance, ownership and licensing
analysis of a specific software package.
|
| SpdxElement |
An SpdxElement is any thing described in SPDX, either a document or an SpdxItem.
|
| SpdxEnumFactory | |
| SpdxExternalRefDifference |
Contains information on differences between two different External Refs.
|
| SpdxFile |
A File represents a named sequence of information
that is contained in a software package.
|
| SpdxFile.SpdxFileBuilder | |
| SpdxFileComparer |
Compares two SPDX files.
|
| SpdxFileDifference |
Contains the results of a comparison between two SPDX files with the same name
|
| SpdxIdInUseException |
Exception when an SPDX element is in use (e.g.
|
| SpdxIdNotFoundException | |
| SpdxInvalidIdException | |
| SpdxInvalidTypeException | |
| SpdxItem |
An SpdxItem is a potentially copyrightable work.
|
| SpdxItemComparer |
Compares two SPDX items.
|
| SpdxItemDifference |
Contains the results of a comparison between two SPDX items with the same name
|
| SpdxLicenseDifference |
Contains the results of a comparison between two SPDX non-standard licenses
where the license text is equivalent and the license comment, license ID, or
other fields are different
|
| SpdxLicenseTemplateHelper |
Implements common conversion methods for processing SPDX license templates
|
| SpdxListedLicense |
Listed license for SPDX as listed at spdx.org/licenses
|
| SpdxListedLicense.Builder | |
| SpdxListedLicenseException | |
| SpdxListedLicenseLocalStore | |
| SpdxListedLicenseModelStore |
Read-only model store for the SPDX listed licenses
License and exception ID's can be case insensitive
License information is stored in a LicenseJson file with the ID being Listed License ID
License Exception information is stored in an ExceptionJson file with the ID being the Listed Exception ID
CrossRef information is stored within the LicenseJson file.
|
| SpdxListedLicenseWebStore | |
| SpdxModelFactory |
Factory class to create ModelObjects based on the type
Types are defined classes in the SpdxConstants class and map to the standard SPDX model
|
| SpdxNoAssertionElement |
This SPDX element represents no assertion as to an actual SPDX element.
|
| SpdxNoAssertionLicense |
Special class of license to represent no asserted license license in the file or packages
|
| SpdxNoneElement |
This SPDX element represents no SPDX element at all.
|
| SpdxNoneLicense |
A special license meaning that no license was found
|
| SpdxObjectNotInStoreException |
Exception when an SDPX ID or object was not found in a model store
|
| SpdxPackage |
A Package represents a collection of software files that are
delivered as a single functional component.
|
| SpdxPackage.SpdxPackageBuilder | |
| SpdxPackageComparer |
Compares two SPDX package.
|
| SpdxPackageVerificationCode | |
| SpdxSnippet |
Snippets can optionally be used when a file is known to have some content that has been included from another original source.
|
| SpdxSnippet.SpdxSnippetBuilder | |
| SpdxSnippetComparer |
Compares two SPDX snippets.
|
| SpdxVerificationHelper |
Holds static methods used for verify various property values
|
| StartEndPointer |
A compound pointer pointing out parts of a document by means of a range delimited by a pair of single pointers that define the start point and the end point.
|
| StoredTypedItem |
Individual item to be stored in memory
|
| TextTemplateOutputHandler |
License template output handler for generating a text version of a license from a license template.
|
| TypedValue |
Value which is a stored typed item
|
| VerificationCodeGenerator |
Generates a package verification code from a directory of source code or an array of
SPDXFiles. |
| Version |
Static class to manage the SPDX versions and the version of the implementation classes
|
| WithExceptionOperator |
A license that has a With exception operator (e.g.
|
| Write |
Static class to provide write operations to the model.
|