Index (spdx-maven-plugin Maven Plugin 0.7.4 API)

A C E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addDependencyInformation(SpdxDependencyInformation) - Method in class org.spdx.maven.utils.SpdxDocumentBuilder: Add dependency information to the SPDX file
addExtractedLicense(NonStandardLicense) - Method in class org.spdx.maven.utils.LicenseManager: Add a non-listed license to the SPDX document.
addMavenDependencies(ProjectBuilder, MavenSession, MavenProject, DependencyNode, SpdxElement) - Method in class org.spdx.maven.utils.SpdxDependencyInformation: Adds information about Maven dependencies to the list of SPDX Dependencies
addNonStandardLicenses(NonStandardLicense[]) - Method in class org.spdx.maven.utils.SpdxDocumentBuilder: Add non-standard licenses to the SPDX document.
Annotation - Class in org.spdx.maven: Simple class to hold an SPDX Annotation.
Annotation() - Constructor for class org.spdx.maven.Annotation: Create a default (empty) annotation

C

collectFiles(List<FileSet>, String, SpdxDefaultFileInformation, Map<String, SpdxDefaultFileInformation>, SpdxPackage, RelationshipType, SpdxDocument, Set<ChecksumAlgorithm>) - Method in class org.spdx.maven.utils.SpdxFileCollector: Collect file information in the directory (including subdirectories).
collectSpdxFileInformation(List<FileSet>, String, SpdxDefaultFileInformation, Map<String, SpdxDefaultFileInformation>, Set<ChecksumAlgorithm>) - Method in class org.spdx.maven.utils.SpdxDocumentBuilder: Collect information at the file level, fill in the SPDX document
convertChecksumToString(byte[]) - Static method in class org.spdx.maven.utils.SpdxFileCollector: Converts an array of bytes to a string compliant with the SPDX sha1 representation
convertFilePathToSpdxFileName(String) - Method in class org.spdx.maven.utils.SpdxFileCollector: Create the SPDX file name from a system specific path name
CreateSpdxMojo - Class in org.spdx.maven: NOTE: Currently this is a prototype plugin for supporting SPDX in a Maven build.
CreateSpdxMojo() - Constructor for class org.spdx.maven.CreateSpdxMojo
CREATOR_TOOL_MAVEN_PLUGIN - Static variable in class org.spdx.maven.CreateSpdxMojo

E

EAR - Enum constant in enum org.spdx.maven.Packaging
EJB - Enum constant in enum org.spdx.maven.Packaging
execute() - Method in class org.spdx.maven.CreateSpdxMojo
execute() - Method in class org.spdx.spdx_maven_plugin.HelpMojo
extensionToFileType(String) - Static method in class org.spdx.maven.utils.SpdxFileCollector
ExternalReference - Class in org.spdx.maven: 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.
ExternalReference() - Constructor for class org.spdx.maven.ExternalReference

F

fillSpdxDocumentInformation(SpdxProjectInformation) - Method in class org.spdx.maven.utils.SpdxDocumentBuilder: Fill in the document level information for SPDX

G

generateChecksum(File, Set<ChecksumAlgorithm>, SpdxDocument) - Static method in class org.spdx.maven.utils.SpdxFileCollector: Generate checksums for a given file using each algorithm supplied.
generateSha1(File, SpdxDocument) - Static method in class org.spdx.maven.utils.SpdxFileCollector: Generate the Sha1 for a given file.
getAnnotationComment() - Method in class org.spdx.maven.Annotation
getAnnotationDate() - Method in class org.spdx.maven.Annotation
getAnnotationType() - Method in class org.spdx.maven.Annotation
getAnnotator() - Method in class org.spdx.maven.Annotation
getArtifactType() - Method in enum org.spdx.maven.OutputFormat
getByteRangeEnd() - Method in class org.spdx.maven.SnippetInfo
getByteRangeStart() - Method in class org.spdx.maven.SnippetInfo
getChecksums() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getComment() - Method in class org.spdx.maven.NonStandardLicense
getComment() - Method in class org.spdx.maven.SnippetInfo
getComment() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getConcludedLicense() - Method in class org.spdx.maven.SnippetInfo
getConcludedLicense() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getConcludedLicense() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getContributors() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getCopyright() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getCopyrightText() - Method in class org.spdx.maven.SnippetInfo
getCopyrightText() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getCreatorComment() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getCreators() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getCrossReference() - Method in class org.spdx.maven.NonStandardLicense
getDeclaredLicense() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getDeclaredLicense() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getDefaultExternalRefs(SpdxDocument, boolean, MavenProject) - Static method in class org.spdx.maven.utils.SpdxExternalRefBuilder
getDefaultFileInformation(SpdxDefaultFileInformation, SpdxDocument) - Method in class org.spdx.maven.PathSpecificSpdxInfo: Get the default file information to be used with this file path
getDescription() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getDocumentAnnotations() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
getDocumentAnnotations() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getDocumentComment() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getDocumentExternalReferences() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
getDownloadUrl() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getExtension(File) - Method in class org.spdx.maven.utils.SpdxFileCollector
getExternalDocuments() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
getExternalRef(SpdxDocument) - Method in class org.spdx.maven.ExternalReference
getExternalRefs() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getExtractedText() - Method in class org.spdx.maven.NonStandardLicense
getFiles() - Method in class org.spdx.maven.utils.SpdxFileCollector
getFileType() - Method in enum org.spdx.maven.OutputFormat
getHomePage() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getInstance() - Static method in class org.spdx.maven.utils.MavenToSpdxLicenseMapper
getLicensComment() - Method in class org.spdx.maven.SnippetInfo
getLicenseComment() - Method in class org.spdx.maven.SnippetInfo
getLicenseComment() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getLicenseComment() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getLicenseConcluded(SpdxDocument) - Method in class org.spdx.maven.SnippetInfo
getLicenseId() - Method in class org.spdx.maven.NonStandardLicense
getLicenseInfoFromFiles() - Method in class org.spdx.maven.utils.SpdxFileCollector
getLicenseInfoInSnippet() - Method in class org.spdx.maven.SnippetInfo
getLicenseInfoInSnippet(SpdxDocument) - Method in class org.spdx.maven.SnippetInfo
getLicenseManager() - Method in class org.spdx.maven.utils.SpdxDocumentBuilder
getLineRangeEnd() - Method in class org.spdx.maven.SnippetInfo
getLineRangeStart() - Method in class org.spdx.maven.SnippetInfo
getMap() - Method in class org.spdx.maven.utils.MavenToSpdxLicenseMapper
getName() - Method in class org.spdx.maven.NonStandardLicense
getName() - Method in enum org.spdx.maven.Packaging
getName() - Method in class org.spdx.maven.SnippetInfo
getName() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getNotice() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getOriginator() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getOutputFormat(String, File) - Static method in enum org.spdx.maven.OutputFormat
getPackageAnnotations() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getPackageArchiveFileName() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getPath() - Method in class org.spdx.maven.PathSpecificSpdxInfo
getPrimaryPurpose() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getProjectPackage() - Method in class org.spdx.maven.utils.SpdxDocumentBuilder
getPurpose() - Method in enum org.spdx.maven.Packaging
getRelationships() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
getShortDescription() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getSnippets() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
getSnippets() - Method in class org.spdx.maven.utils.SpdxFileCollector
getSourceInfo() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getSpdxDoc() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
getSpdxDoc() - Method in class org.spdx.maven.utils.SpdxDocumentBuilder
getSupplier() - Method in class org.spdx.maven.utils.SpdxProjectInformation
getVerificationCode(String, SpdxDocument) - Method in class org.spdx.maven.utils.SpdxFileCollector: Create a verification code from all SPDX files collected
getVersionInfo() - Method in class org.spdx.maven.utils.SpdxProjectInformation

H

HelpMojo - Class in org.spdx.spdx_maven_plugin: Display help information on spdx-maven-plugin.
Call mvn spdx:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
HelpMojo() - Constructor for class org.spdx.spdx_maven_plugin.HelpMojo

I

INCLUDE_ALL - Static variable in class org.spdx.maven.CreateSpdxMojo
isCreateExternalRefs() - Method in class org.spdx.maven.utils.SpdxDependencyInformation
isSourceFile(Collection<FileType>) - Method in class org.spdx.maven.utils.SpdxFileCollector

J

JAR - Enum constant in enum org.spdx.maven.Packaging
JSON - Enum constant in enum org.spdx.maven.OutputFormat
JSON_OUTPUT_FORMAT - Static variable in class org.spdx.maven.CreateSpdxMojo

L

LicenseManager - Class in org.spdx.maven.utils: Manages the SPDX licenses for the Spdx plugin.
LicenseManager(SpdxDocument, boolean) - Constructor for class org.spdx.maven.utils.LicenseManager: License manager will track any extracted SPDX licenses and map between SPDX licenses and Maven licenses.
LicenseManagerException - Exception in org.spdx.maven.utils: Exceptions related to the LicenseManager
LicenseManagerException(String) - Constructor for exception org.spdx.maven.utils.LicenseManagerException
LicenseManagerException(String, Throwable) - Constructor for exception org.spdx.maven.utils.LicenseManagerException
LicenseManagerException(Throwable) - Constructor for exception org.spdx.maven.utils.LicenseManagerException
LicenseMapperException - Exception in org.spdx.maven.utils: Errors related to mapping Maven licenses to SPDX licenses
LicenseMapperException() - Constructor for exception org.spdx.maven.utils.LicenseMapperException
LicenseMapperException(String) - Constructor for exception org.spdx.maven.utils.LicenseMapperException
LicenseMapperException(String, Throwable) - Constructor for exception org.spdx.maven.utils.LicenseMapperException
LicenseMapperException(Throwable) - Constructor for exception org.spdx.maven.utils.LicenseMapperException
logInfo() - Method in class org.spdx.maven.Annotation
logInfo() - Method in class org.spdx.maven.SnippetInfo
logInfo() - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation: Primarily for debugging purposes.
logInfo(SpdxDocument) - Method in class org.spdx.maven.utils.SpdxProjectInformation: Log information on all fields - typically used for debugging

M

MAVEN_PLUGIN - Enum constant in enum org.spdx.maven.Packaging
mavenLicenseListToSpdxLicense(List<License>) - Method in class org.spdx.maven.utils.LicenseManager: Map a list of Maven licenses to an SPDX license.
mavenLicenseListToSpdxLicense(List<License>, SpdxDocument) - Method in class org.spdx.maven.utils.MavenToSpdxLicenseMapper: Map a list of Maven licenses to an SPDX license.
mavenLicenseToSpdxLicense(License) - Method in class org.spdx.maven.utils.LicenseManager: Map a Maven license to an SPDX license based on the URL
MavenToSpdxLicenseMapper - Class in org.spdx.maven.utils: Singleton class which maps Maven license objects to SPDX licenses.
MAXIMUM_SOURCE_FILE_LENGTH - Static variable in class org.spdx.maven.utils.SpdxSourceFileParser

N

NonStandardLicense - Class in org.spdx.maven: Non-standard license (e.g.
NonStandardLicense() - Constructor for class org.spdx.maven.NonStandardLicense: Create a default, non standard license
NULL_SHA1 - Static variable in class org.spdx.maven.utils.SpdxDocumentBuilder

O

org.spdx.maven - package org.spdx.maven
org.spdx.maven.utils - package org.spdx.maven.utils
org.spdx.spdx_maven_plugin - package org.spdx.spdx_maven_plugin
OutputFormat - Enum in org.spdx.maven: OutputFormat utility enum

P

Packaging - Enum in org.spdx.maven: Packaging utility enum
parseFileForSpdxLicenses(File) - Static method in class org.spdx.maven.utils.SpdxSourceFileParser: Parses a text file for matches to SPDX-License-Identifier:
parseTextForSpdxLicenses(String) - Static method in class org.spdx.maven.utils.SpdxSourceFileParser
PathSpecificSpdxInfo - Class in org.spdx.maven: Simple class to hold SPDX data for a file or directory.
PathSpecificSpdxInfo() - Constructor for class org.spdx.maven.PathSpecificSpdxInfo: Default constructor
POM - Enum constant in enum org.spdx.maven.Packaging

R

RAR - Enum constant in enum org.spdx.maven.Packaging
RDF_OUTPUT_FORMAT - Static variable in class org.spdx.maven.CreateSpdxMojo
RDF_XML - Enum constant in enum org.spdx.maven.OutputFormat

S

saveSpdxDocumentToFile() - Method in class org.spdx.maven.utils.SpdxDocumentBuilder
setAnnotationComment(String) - Method in class org.spdx.maven.Annotation
setAnnotationDate(String) - Method in class org.spdx.maven.Annotation
setAnnotationType(String) - Method in class org.spdx.maven.Annotation
setAnnotator(String) - Method in class org.spdx.maven.Annotation
setByteRange(String) - Method in class org.spdx.maven.SnippetInfo
setChecksums(Set<Checksum>) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setComment(String) - Method in class org.spdx.maven.NonStandardLicense
setComment(String) - Method in class org.spdx.maven.SnippetInfo
setComment(String) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setConcludedLicense(String) - Method in class org.spdx.maven.SnippetInfo
setConcludedLicense(AnyLicenseInfo) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setConcludedLicense(AnyLicenseInfo) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setContributors(String[]) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setCopyright(String) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setCopyrightText(String) - Method in class org.spdx.maven.SnippetInfo
setCopyrightText(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setCreatorComment(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setCreators(String[]) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setCrossReference(URL[]) - Method in class org.spdx.maven.NonStandardLicense
setDeclaredLicense(AnyLicenseInfo) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setDeclaredLicense(AnyLicenseInfo) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setDescription(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setDocumentAnnotations(Annotation[]) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setDocumentComment(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setDownloadUrl(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setExternalRefs(ExternalReference[]) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setExtractedText(String) - Method in class org.spdx.maven.NonStandardLicense
setHomePage(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setLicenseComment(String) - Method in class org.spdx.maven.SnippetInfo
setLicenseComment(String) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setLicenseComment(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setLicenseId(String) - Method in class org.spdx.maven.NonStandardLicense
setLicenseInfoInSnippet(String) - Method in class org.spdx.maven.SnippetInfo
setLineRange(String) - Method in class org.spdx.maven.SnippetInfo
setName(String) - Method in class org.spdx.maven.NonStandardLicense
setName(String) - Method in class org.spdx.maven.SnippetInfo
setName(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setNotice(String) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setOriginator(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setPackageAnnotations(Annotation[]) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setPackageArchiveFileName(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setPrimaryPurpose(Purpose) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setShortDescription(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setSnippets(List<SnippetInfo>) - Method in class org.spdx.maven.utils.SpdxDefaultFileInformation
setSourceInfo(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setSupplier(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
setVersionInfo(String) - Method in class org.spdx.maven.utils.SpdxProjectInformation
SnippetInfo - Class in org.spdx.maven: Simple class to hold information about snippets
SnippetInfo() - Constructor for class org.spdx.maven.SnippetInfo
SPDX_JSON_ARTIFACT_TYPE - Static variable in class org.spdx.maven.CreateSpdxMojo
SPDX_LICENSE_PATTERN - Static variable in class org.spdx.maven.utils.SpdxSourceFileParser
SPDX_RDF_ARTIFACT_TYPE - Static variable in class org.spdx.maven.CreateSpdxMojo
SpdxBuilderException - Exception in org.spdx.maven.utils: Exceptions relating to the building of SPDX Documents
SpdxBuilderException(String) - Constructor for exception org.spdx.maven.utils.SpdxBuilderException
SpdxBuilderException(String, Throwable) - Constructor for exception org.spdx.maven.utils.SpdxBuilderException
SpdxCollectionException - Exception in org.spdx.maven.utils: Exceptions for the collection of SPDX information
SpdxCollectionException() - Constructor for exception org.spdx.maven.utils.SpdxCollectionException
SpdxCollectionException(String) - Constructor for exception org.spdx.maven.utils.SpdxCollectionException
SpdxCollectionException(String, Throwable) - Constructor for exception org.spdx.maven.utils.SpdxCollectionException
SpdxCollectionException(Throwable) - Constructor for exception org.spdx.maven.utils.SpdxCollectionException
SpdxDefaultFileInformation - Class in org.spdx.maven.utils: Simple structure to hold information obout default file information
SpdxDefaultFileInformation() - Constructor for class org.spdx.maven.utils.SpdxDefaultFileInformation
SpdxDependencyInformation - Class in org.spdx.maven.utils: Contains information about package dependencies collected from the Maven dependencies.
SpdxDependencyInformation(LicenseManager, SpdxDocument, boolean, boolean, boolean, boolean) - Constructor for class org.spdx.maven.utils.SpdxDependencyInformation
SpdxDocumentBuilder - Class in org.spdx.maven.utils: Builds SPDX documents for a given set of source files.
SpdxDocumentBuilder(MavenProject, boolean, File, URI, boolean, OutputFormat) - Constructor for class org.spdx.maven.utils.SpdxDocumentBuilder
SpdxExternalRefBuilder - Class in org.spdx.maven.utils
SpdxExternalRefBuilder() - Constructor for class org.spdx.maven.utils.SpdxExternalRefBuilder
SpdxFileCollector - Class in org.spdx.maven.utils: Collects SPDX file information from directories.
SpdxFileCollector() - Constructor for class org.spdx.maven.utils.SpdxFileCollector: SpdxFileCollector collects SPDX file information for files
spdxLicenseToMavenLicense(AnyLicenseInfo) - Method in class org.spdx.maven.utils.LicenseManager: Create a Maven license from the SPDX license
SpdxProjectInformation - Class in org.spdx.maven.utils: Simple structure to hold information about SPDX project
SpdxProjectInformation() - Constructor for class org.spdx.maven.utils.SpdxProjectInformation
SpdxSourceFileParser - Class in org.spdx.maven.utils: Helper class with static methods to parse SPDX source files
SpdxSourceFileParser() - Constructor for class org.spdx.maven.utils.SpdxSourceFileParser
SpdxSourceParserException - Exception in org.spdx.maven.utils: Exceptions related to parsing source files for SPDX identifiers
SpdxSourceParserException(String) - Constructor for exception org.spdx.maven.utils.SpdxSourceParserException
SpdxSourceParserException(String, Throwable) - Constructor for exception org.spdx.maven.utils.SpdxSourceParserException
SpdxSourceParserException(String, Throwable, boolean, boolean) - Constructor for exception org.spdx.maven.utils.SpdxSourceParserException
SpdxSourceParserException(Throwable) - Constructor for exception org.spdx.maven.utils.SpdxSourceParserException

T

toSpdxAnnotation(SpdxDocument) - Method in class org.spdx.maven.Annotation

U

urlToSpdxId(String) - Method in class org.spdx.maven.utils.MavenToSpdxLicenseMapper

V

valueOf(String) - Static method in enum org.spdx.maven.OutputFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spdx.maven.Packaging: Returns the enum constant of this type with the specified name.
valueOfPackaging(String) - Static method in enum org.spdx.maven.Packaging
values() - Static method in enum org.spdx.maven.OutputFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spdx.maven.Packaging: Returns an array containing the constants of this enum type, in the order they are declared.

W

WAR - Enum constant in enum org.spdx.maven.Packaging

A C E F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form