All Classes
| Class | Description |
|---|---|
| AbstractFileCompareSheet |
Abstract worksheet for any comparison involving files.
|
| AbstractJsonFile |
Supports writing files in JSON format
Implementation classes need to implement the getJsonObject method to provide the JSON object to be written
|
| AbstractSheet |
Abstract class representing a workbook sheet used in storing structured data
|
| AbstractSpreadsheet |
Abstract class for implementing file based spreadsheets.
|
| Annotation |
An Annotation is a comment on an SpdxItem by an agent.
|
| Annotation.AnnotationType | |
| AnnotationContext |
Context for an Annotation
|
| AnnotationsSheet |
Sheet containing all annotations
|
| AnyLicenseInfo |
This abstract class represents several ways of describing licensing information.
|
| BuildDocument |
Translates an tag-value file to a an SPDX Document.
|
| BuildLegacyDocument | Deprecated. |
| ByteOffsetPointer | |
| Checksum |
A Checksum is value that allows the contents of a file to be authenticated.
|
| Checksum.ChecksumAlgorithm | |
| CommonCode |
Define Common methods used by Tag-Value and SPDXViewer to print the SPDX
document.
|
| CompareHelper |
Helper class for comparisons
|
| CompareMultpleSpdxDocs |
Compares multiple SPDX documents and stores the results in a spreadsheet
Usage: CompareSpdxDoc output.xls doc1 doc2 doc3 ...
|
| CompareSpdxDocs |
Command line application to compare two SPDX documents
Usage: CompareSpdxDoc doc1 doc2 [output]
where doc1 and doc2 are two SPDX documents in either RDF/XML or tag/value format
and [output] is an optional SPDX document
|
| 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
|
| CreatorInfoContext |
Mustache Context for converting an SPDX Document for use in the SpdxHTMLTemplate
The constants are used in the SpdxHTMLTemplate.html file in the resources directory.
|
| CreatorSheet |
Worksheet containing creator level information
Column 1 describes if the creator is the same or different
Columns 2 through N are for creators in each of the documents
|
| CrossRef |
Cross reference details for the a URL reference
|
| DisjunctiveLicenseSet |
A set of licenses where there is a choice of one of the licenses in the set
|
| DoapProject |
Contains a DOAP project
Currently, only the home page and name properties are supported
|
| DOAPProject | Deprecated. |
| DocumentAnnotationSheet |
Sheet for document level annotations
|
| DocumentInfoSheet |
Abstract class for sheet containing information about the origins of an SPDX document
Specific versions implemented as subclasses
|
| DocumentRelationshipSheet |
Sheet for document level relationships
|
| DocumentSheet |
Sheet to hold compare information at the docment level:
Created, Data License, Document Comment
The first row summarizes which fields are different, the subsequent rows are the
specific date from each result
|
| DuplicateExtractedLicenseIdException |
A duplicate license ID for an extracted license
|
| ElementContext |
Mustache context holding only the element ID, name and the URL link to the element
|
| ExceptionJsonTOC |
Table of Contents for the listed exception list as represented as a JSON index file
at spdx.org/licenses/exceptions.json
|
| ExceptionTOCJSONFile |
This class holds a JSON file for a license exception table of contents
|
| ExternalDocumentRef |
Information about an external SPDX document reference including the checksum.
|
| 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.
|
| ExternalRef.ReferenceCategory | |
| ExternalRefContext | |
| ExternalReferencesSheet |
Sheet that compares the external document references
|
| ExternalRefsSheet |
Package external refs
|
| 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.
|
| ExtractedLicenseSheet |
Comparison results for extracted licenses
Column 1 contains the extracted text
Columns 2 through N contains the license information in the format licenseId [licenseName] {licenceUrls} (licenseComment)
|
| ExtractedLicensingInfoContext | |
| FileAnnotationSheet |
Sheet comparing file annotations
|
| FileArtifactOfSheet | |
| FileAttributionSheet |
Sheet with results for file contributor comparison results
|
| FileChecksumSheet |
Sheet of comparison results for file checksums
|
| FileCommentSheet |
Sheet continaing results for file comment comparison
|
| FileConcludedSheet | |
| FileContext |
Context for describing SPDX Files
|
| FileContributorsSheet |
Sheet with results for file AttributionText comparison results
|
| FileCopyrightSheet |
Sheet comparing file copyrights
|
| FileDependenciesSheet |
Sheet for file dependency comaparison results
|
| FileLicenseCommentsSheet |
Sheet of comparison results for file license comments
|
| FileLicenseInfoSheet |
Sheet of the comparison results for the file seen licenses
|
| FileNoticeSheet |
Sheet for file notice comparison results
|
| FileRelationshipSheet |
Sheet comparing file relationships
|
| FileSpdxIdSheet | |
| FileTypeSheet |
Sheet containing File Type
|
| FilterTemplateOutputHandler |
Filter the template output to create a list of strings filtering out optional and/or var text
|
| GenerateVerificationCode |
Generates a verification code for a specific directory
|
| HandBuiltParser |
I'm hoping this is a temporary solution.
|
| 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.
|
| IModelContainer |
Interface for a a class that contains an RDF model
|
| InvalidFileFormatException |
Exceptions for invalid SPDX file format
|
| InvalidLicenseStringException |
Exceptions related to License Strings stored in the spreadsheet.
|
| InvalidLicenseTemplateException |
Exceptions related to invalid license templates
|
| InvalidSPDXAnalysisException |
Exception for invalid SPDX Documents
|
| InvalidSpdxTagFileException |
Exceptions for errors in a SPDX tag format file
|
| IRdfModel |
Interface to translate from a Java model to a Jena RDF model
|
| ISpdxListedLicenseProvider |
Interface to provide SPDX standard licenses
|
| 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
|
| LicenseCsvException | |
| LicenseException |
Represents an SPDX license exception as defined in the License Expression Language
Used with the "with" unary expression.
|
| LicenseExceptionJSONFile |
This class holds a JSON details file for a specific license
|
| LicenseExpressionParser |
A parser for the SPDX License Expressions as documented in the SPDX appendix.
|
| LicenseInfoFactory |
Factory for creating SPDXLicenseInfo objects from a Jena model
|
| LicenseJSONFile |
This class holds a JSON details file for a specific license
|
| LicenseJsonTOC |
Table of Contents for the listed license list as represented as a JSON index file
at spdx.org/licenses/licenses.json
|
| LicenseParserException |
Exception caused by an invalid license expression
|
| LicenseRestrictionException |
Java Exception while processing or handling SPDXLicenseExceptions
|
| 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
|
| LicenseTOCJSONFile |
This class holds a JSON file for a license table of contents
|
| LineCharPointer | |
| LineColumn |
Holds information on lines and columns
|
| ListedExceptions |
Singleton class which holds the listed exceptions
|
| ListedLicenseException |
Exceptions listed in the SPDX license list
|
| ListedLicenses |
Singleton class which holds the listed licenses
|
| ListedReferenceTypes |
Singleton class that maintains the current SPDX listed reference types.
|
| Main |
Dispatch to the individual tools
|
| MatchingStandardLicenses |
Tool to compare a license text to standard licenses.
|
| MergeSpdxDocs |
Commend line application to merge multiple SPDX documents into one single documents
Usage: MergeSpdxDocs doc1 doc2 doc3 ...
|
| MultiDocumentSpreadsheet |
Spreadsheet holding the results of a comparison from multiple SPDX documents
Each sheet contains the comparison result results with the columns representing the SPDX documents
and the rows representing the SPDX fields.
|
| MustacheMap |
Provides a hashmap which maps the Mustache template strings to SPDX Document
methods and strings.
|
| NoCommentInputStream | |
| NoListedLicenseRdfModel | |
| NonNumericLicenseIdException |
Exception for non standard license IDs where a numeric value is expected and
no numeric value is found
|
| NonStandardLicensesSheet |
Abstract sheet for NonSTandardLicenses.
|
| NonStandardLicensesSheetV0d9d4 |
Sheet containing the text of any non-standard licenses found in an SPDX document
|
| NonStandardLicensesSheetV1d1 |
Sheet containing the text of any non-standard licenses found in an SPDX document
Implementat for version 1.1
|
| NormalizedFileNameComparator |
Compares to file name strings normalizing them to a common format using the following rules:
- File separator character is "/"
- Must begin with "./"
|
| OnlineToolException |
Default Exception thrown to the Online Tool
|
| OriginsSheetV0d9d4 |
Sheet containing information about the origins of an SPDX document
|
| OriginsSheetV1d1 |
Sheet containing information about the origins of an SPDX document
Version 1.1
|
| OriginsSheetV1d2 | |
| OriginsSheetV2d0 | |
| OrLaterOperator |
A license that has an or later operator (e.g.
|
| PackageContext |
Context for SPDX Package
|
| PackageInfoSheet |
Abstract PackageInfoSheet to manage cross-version implementations
|
| PackageInfoSheetV09d2 |
Sheet describing the package information for an SPDX Document
|
| PackageInfoSheetV09d3 | |
| PackageInfoSheetV1d2 |
Version 1.2 implementation of PackageInfo Sheet - added home page column
|
| PackageInfoSheetV2d0 | |
| PackageInfoSheetV2d1 |
Version 2.1 of the package info sheet
|
| PackageInfoSheetV2d2 |
Version 2.1 of the package info sheet
|
| PackageInfoSheetV9d1 |
Sheet describing the package information for an SPDX Document
|
| PackageSheet |
Document level fields for comparison spreadsheet
Column1 is the document field name, column2 indicates if all docs are equal,
columns3 through columnN are document specific field values
|
| PerFileSheet |
Abstract class for PerFileSheet.
|
| PerFileSheetV09d3 |
Sheet describing the per file information in an SPDX Document
|
| PerFileSheetV1d1 |
Sheet describing the per file information in an SPDX Document
|
| PerFileSheetV1d2 | |
| PerFileSheetV2d0 | |
| PerFileSheetV2d2 | |
| PointerFactory |
Factory for creating pointer classes based on the information in the model.
|
| ProjectContext |
Context for a DOAP Project reference
|
| RdfModelHelper |
Static class containing helper methods for implementations of IRdfModel
|
| RdfModelObject |
The superclass for all classes the use the Jena RDF model.
|
| RdfParserHelper |
Helper class with common functions used by the RDF Parser
|
| RdfToHtml |
Takes an input SPDX Document and produces the following HTML files in the
specified directory: [spdxdocumentname]-document.html - Document level
information [spdxpackagename]-package.html - Package level information (one
per package found) [spdxpackagename]-packagefiles.html - File level
information for all files found in the given package
[spdxdocumentname]-packagefiles.html - File level information for all files
described directly by the document [spdxdocumentname]-extractedlicenses.html
- Extracted license information from the document The HTML pretty printer is
based on a set of HTML templates found in the resources directory:
SpdxDocHTMLTemplate.html - Document level HTML file template
PackageHTMLTemplate.html - Package level HTML file template
FilesHTMLTemplate.html - File level information HTML file template
LicensesHTMLTemplate.html - Extracted license information HTML file template
The template uses Mustache - see http://mustache.github.com/mustache.5.html
|
| RdfToSpreadsheet |
Translates an RDF XML file to a SPDX Spreadsheet format
Usage: RdfToSpreadsheet rdfxmlfile.rdf spreadsheetfile.xls
where rdfxmlfile.rdf is a valid SPDX RDF XML file and spreadsheetfile.xls is
the output SPDX spreadsheeet file.
|
| RdfToTag |
Translates an RDF XML file to a tag-value format Usage: RdfToTag
rdfxmlfile.rdf spdxfile.spdx where rdfxmlfile.rdf is a valid SPDX RDF XML
file and spdxfile.spdx is the output SPDX tag-value file.
|
| 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.
|
| Relationship |
A Relationship represents a relationship between two SpdxElements.
|
| Relationship.RelationshipType | |
| RelationshipContext |
Mustache context for relationships
|
| RelationshipsSheet |
Sheet containing relationship data
|
| ReviewerContext | |
| ReviewerSheet |
Sheet of Reviewer comparisons between SPDX documents
Columns 1 through N are for reviewers in each of the documents
Format of the reviewer is ReviewerName [date] (comment)
|
| ReviewersSheet |
Sheet describing any reviewers for an SPDX Document
|
| SimpleLicensingInfo |
The SimpleLicenseInfo class includes all resources that represent
simple, atomic, licensing information.
|
| SinglePointer |
A pointing method made up of a unique pointer.
|
| SnippetContext |
Mustache Context for a snippet
|
| SnippetSheet |
Comparsion sheet for SPDX Snippets
|
| SnippetSheet |
Sheet to hold all snippet information
|
| SPDXChecksum | Deprecated. |
| 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 reviewers, the comparison results are separated into unique reviewers for a give document
which can be obtained by the method getUniqueReviewers(index1, index2). |
| SpdxComparer.SPDXReviewDifference |
Contains the results of a comparison between two SPDXReviews where
the reviewer name is the same but there is a difference in the
reviewer comment or the reviewer date
|
| SpdxConstantElement |
Type of SpdxElement which is a constant unmodifiable element
|
| SPDXCreatorInformation |
Creator class for SPDX documents
|
| SpdxDocument |
An SpdxDocument is a summary of the contents, provenance, ownership and licensing
analysis of a specific software package.
|
| SPDXDocument | Deprecated. |
| SpdxDocumentContainer |
This class contains the SPDX Document and provides some of the basic
RDF model support.
|
| SPDXDocumentFactory |
Factory for creating an SPDX Document from a variety of different sources
|
| SpdxElement |
An SpdxElement is any thing described in SPDX, either a document or an SpdxItem.
|
| SpdxElementFactory |
Factory for creating SpdxElements from a Jena Model
|
| 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 | Deprecated. |
| SpdxFile.FileType | |
| SpdxFileComparer |
Compares two SPDX files.
|
| SpdxFileDifference |
Contains the results of a comparison between two SPDX files with the same name
|
| SpdxFileInfoMerger |
Application to merge SPDX files information into one unique result.
|
| 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
|
| SpdxItemInfoMerger | |
| 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
|
| SPDXLicenseInfoFactory | Deprecated. |
| SpdxLicenseInfoMerger |
Application to merge SPDX documents' non-standard license information and return the results to the merge main class
The non-standard license information from the output SPDX document will add to the result arraylist directly.
|
| SpdxLicenseMapper | |
| SpdxLicenseTemplateHelper |
Implements common conversion methods for processing SPDX license templates
|
| SpdxListedLicense |
Listed license for SPDX as listed at spdx.org/licenses
|
| SpdxListedLicenseException | |
| SpdxMergeException | |
| 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
|
| SpdxPackage |
A Package represents a collection of software files that are
delivered as a single functional component.
|
| SpdxPackageComparer |
Compares two SPDX package.
|
| SPDXPackageInfo | Deprecated. |
| SpdxPackageInfoMerger |
Application to merge package information from input SPDX documents and file information merging result.
|
| SpdxPackageVerificationCode |
Contains an SPDX Package Verification Code, currently consisting
of a value and list of excluded files.
|
| SpdxRdfConstants |
Constants which map to the SPDX specifications found at http://spdx.org/rdf/terms
|
| SPDXReview |
Reviewer class for SPDX Analysis
|
| SpdxSnippet | |
| SpdxSnippetComparer |
Compares two SPDX snippets.
|
| SPDXSpreadsheet |
A spreadsheet containing information on an SPDX Document.
|
| SpdxVerificationException | |
| SpdxVerificationHelper |
Holds static methods used for verify various property values
|
| SpdxViewer |
Simple pretty printer for SPDX RDF XML files.
|
| SpreadsheetException | |
| SpreadsheetToRDF |
Converts a spreadsheet to an SPDX RDF Analysis file
Usage: SpreadsheetToRDF spreadsheetfile.xls rdfxmlfile.rdf
where spreadsheetfile.xls is a valid SPDX Spreadsheet and
rdfxmlfile.rdf is the output SPDX RDF Analysis file.
|
| SpreadsheetToTag |
Converts a spreadsheet to a tag-value format Usage: SpreadsheetToTag
spreadsheetfile.xls spdxfile.spdx where spreadsheetfile.xls is a valid SPDX
Spreadsheet and spdxfile.spdx is the output SPDX tag-value file.
|
| 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.
|
| TagToRDF |
Translates a tag-value file to an RDF XML format Usage: TagToRDF
spdxfile.spdx rdfxmlfile.rdf where spdxfile.spdx is a valid SPDX tag-value
file and rdfxmlfile.rdf is the output SPDX RDF file.
|
| TagToSpreadsheet |
Translates an tag-value file to a SPDX Spreadsheet format Usage:
TagToSpreadsheet spdxfile.spdx spreadsheetfile.xls where spdxfile.spdx is a
valid SPDX tag-value file and spreadsheetfile.xls is the output SPDX
spreadsheeet file.
|
| TagValueBehavior |
Translates an tag-value file to a an SPDX Document.
|
| TagValueParserTokenTypes | |
| TextTemplateOutputHandler |
License template output handler for generating a text version of a license from a license template.
|
| VerificationCodeContext |
Context for a Package Verification Code
|
| VerificationCodeGenerator |
Generates a package verification code from a directory of source code or an array of
SPDXFiles. |
| VerificationSheet |
Worksheet containing verification errors
Columns are package names, rows are individual verification errors
|
| Verify |
Verifies an SPDX document and lists any verification errors
|
| WithExceptionOperator |
A license that has a With exception operator (e.g.
|