All Classes and Interfaces
Class
Description
ExtractedLicenseInfo which can be represented as a concrete ExtractedLicenseInfo within
the same SPDX document with all properties accessible, or as an ExternalExtractedLicenseInfo
which represents a license not included within the SPDX document.
An Annotation is a comment on an SpdxItem by an agent.
Annotation types for the Annotation Class
This abstract class represents several ways of describing licensing information.
Byte offset pointer per RDF 2.3.2.2 ByteOffsetPointer Class
A Checksum is value that allows the contents of a file to be authenticated.
Enum constants for Checksum Algorithms
Compares the output of a parsed license template to text.
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.
The configuration class for the Spdx-Java-Library.
A set of licenses where all of the licenses apply
Cross reference details for the a URL reference
A set of licenses where there is a choice of one of the licenses in the set
This singleton class provides a flexible download cache for the rest of the library.
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
Table of Contents for the listed license list as represented as a JSON index file
at spdx.org/licenses/licenses.json
A simple abstract SPDX store that stores everything in an underlying model store which is initialized in the
constructor.
Information about an external SPDX document reference including the checksum.
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.
This is an SPDX element which is in an external document.
An ExtractedLicensingInfo represents a license or licensing notice that was found in the package.
File Type is intrinsic to the file, independent of how the file is being used.
Deprecated.
Primarily used for testing, this model object does not implement any unique getters and setters nor
does it implement any verification.
Generic SPDX element - primarily used for testing
Generic SPDX item - primarily used for testing
License template output handler for generating an HTML version of a license from a license template.
Interface for implementations of generators of file checksums
Handles output for parsed license templates.
Service Provider Interface for storing and retrieving SPDX properties for SPDX documents.
Different types of ID's
Classes which implement the IndividuallUriValue interface will be stored as a single value.
Exceptions related to invalid license templates
A model store that can be serialized and de-serialized to and from a
StreamJava sha1 checksum generator using MessageDigest
Describes a license
All licenses have an ID.
Primarily a static class of helper functions for comparing two SPDX licenses
Represents an SPDX license exception as defined in the License Expression Language
Used with the "with" unary expression.
A parser for the SPDX License Expressions as documented in the SPDX appendix.
Factory for creating SPDXLicenseInfo objects from a Jena model
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
Table of Contents for the listed license list as represented as a JSON index file
at spdx.org/licenses/licenses.json
Exception caused by an invalid license expression
A specific form of license information where there is a set of licenses
represented
Implements a license rule
Exception for license template rules
Holds information on lines and columns
Represents a License Exception present on the SPDX License List
Singleton class which holds the listed licenses
Singleton class that maintains the current SPDX listed reference types.
Collection of elements stored in a ModelStore
This class helps facilitate copying objects from one model to another.
A ModelCollection implemented as a set where all items in the collection are unique based
on equality (not based on equivalence).
This static helper class converts objects used in the model to and from objects used by the SPI / storage class.
A license that has an or later operator (e.g.
Package Purpose is intrinsic to how the package is being used rather than the content of the package.
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/
Reference category for external refs
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.
A Relationship represents a relationship between two SpdxElements.
Relationship types
The SimpleLicenseInfo class includes all resources that represent
simple, atomic, licensing information.
Simple class to just store a URI value.
A pointing method made up of a unique pointer.
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).Type of SpdxElement which is a constant unmodifiable element
Constants which map to the SPDX specifications found at http://spdx.org/rdf/terms
An SpdxDocument is a summary of the contents, provenance, ownership and licensing
analysis of a specific software package.
An SpdxElement is any thing described in SPDX, either a document or an SpdxItem.
Contains information on differences between two different External Refs.
A File represents a named sequence of information
that is contained in a software package.
Compares two SPDX files.
Contains the results of a comparison between two SPDX files with the same name
Exception when an SPDX element is in use (e.g.
An SpdxItem is a potentially copyrightable work.
Compares two SPDX items.
Contains the results of a comparison between two SPDX items with the same name
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
Implements common conversion methods for processing SPDX license templates
Listed license for SPDX as listed at spdx.org/licenses
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.
Factory class to create ModelObjects based on the type
Types are defined classes in the SpdxConstants class and map to the standard SPDX model
This SPDX element represents no assertion as to an actual SPDX element.
Special class of license to represent no asserted license license in the file or packages
This SPDX element represents no SPDX element at all.
A special license meaning that no license was found
Exception when an SDPX ID or object was not found in a model store
A Package represents a collection of software files that are
delivered as a single functional component.
Compares two SPDX package.
Snippets can optionally be used when a file is known to have some content that has been included from another original source.
Compares two SPDX snippets.
Holds static methods used for verify various property values
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.
Individual item to be stored in memory
Constructs a regular expression from a license or exception template and provide a matching method
to see if code matching the template exists within the text provided
Note that the regular expression assumes a fully normalized text string to match
isTemplateMatchWithinText(String text) will return true if the text text matches the template
getQuickMatchRegex() will return a regular expression with limited backtracking which can be used for a quick search
getCompleteRegex() will return a regular expression for the entire license where
getStartRegex(int wordLimit) will return a regular expression to match the beginning of a license
and getEndRegex(int wordLimit) will return a regular expression to match the end of a licenseLicense template output handler for generating a text version of a license from a license template.
Value which is a stored typed item
Generates a package verification code from a directory of source code or an array of
SPDXFiles.Static class to manage the SPDX versions and the version of the implementation classes
A license that has a With exception operator (e.g.
Static class to provide write operations to the model.
TemplateRegexMatcherclass should be used in place of this class.