Package org.spdx.tools

package org.spdx.tools
  • Class
    Description
    CompareSpdxDocs
    Compares multiple SPDX documents and stores the results in a spreadsheet Usage: CompareSpdxDoc output.xlsx doc1 doc2 doc3 ... docN where output.xls is a file name for the output spreadsheet file and docX are SPDX document files to compare or directories containing SPDX documents.
    ExitCode
    Shared process exit status codes for the command line tools.
    GenerateVerificationCode
    Generates a verification code for a specific directory
    Exit codes: 0 - the verification code was generated successfully 1 - the verification code could not be generated 2 - the command was invoked incorrectly (missing/invalid arguments)
    InvalidFileNameException
    Illegal parameter fro a file name
    Main
    Dispatch individual tools
    Each dispatched tool's main() calls System.exit() itself, which terminates the process immediately with that tool's own exit status - so the exit codes below only apply when no tool is actually dispatched: 0 - success (e.g. the "Version" command, which is handled here directly instead of being dispatched) 2 - the command was invoked incorrectly (missing/unrecognized tool name)
    MatchingStandardLicenses
    Tool to compare a license text to standard licenses.
    OnlineToolException
    Default Exception thrown to the Online Tool
    RdfSchemaToJsonContext
    Convert an RDF schema file containing SPDX property to a JSON context file for all properties in the SPDX namespace
    RdfSchemaToJsonSchema
    Convert an RDF schema file containing SPDX property to a JSON schema file for all properties in the SPDX namespace
    RdfSchemaToXsd
    Convert an RDF OWL document to an XML Schema
    SpdxConverter
    Converts between various SPDX file types arg[0] from file path arg[1] to file path arg[2] from file type [RDFXML|RDFTTL|JSON|XLS|XLSX|YAML|TAG] - if not present, file type of the from file will be used arg[3] to file type [RDFXML|RDFTTL|JSON|XLS|XLSX|YAML|TAG] - if not present, file type of the to file will be used arg[4] excludeLicenseDetails If present, listed license and listed exception properties will not be included in the output file the covert(...) methods can be called programmatically to convert files
    Exit codes: 0 - the conversion succeeded 1 - the conversion failed 2 - the command was invoked incorrectly (missing/invalid arguments)
    SpdxConverterException
    Exceptions related to the SPDX converter utility
    SpdxToolsHelper
    Static helper methods for the various tools
    SpdxToolsHelper.SerFileType
    Supported serialization file types
    SpdxVerificationException
    Exceptions for the SPDX Verify tools
    SpdxVersion
    Static helper methods for tools and library version information
    SpdxViewer
    Simple pretty printer for SPDX RDF XML files.
    Verify
    Verifies an SPDX document and lists any verification errors
    Exit codes: 0 - the SPDX document is valid 1 - the SPDX document is invalid, or could not be read/parsed 2 - the command was invoked incorrectly (missing/invalid arguments)