A B C D E G H I K L O R S T V W

A

AbstractValidationMojo - Class in com.puresoltechnologies.maven.plugins.license

This abstract class provides basic functionality for all license validations.

AbstractValidationMojo() - Constructor for class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

addDependency(DependencyTree) - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

This method adds a new dependency.

ArtifactInformation - Class in com.puresoltechnologies.maven.plugins.license.parameter

This class contains artifact information to identify it.

ArtifactInformation(String, String, String, String, String, String) - Constructor for class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

ArtifactInformation(Artifact) - Constructor for class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

ArtifactUtilities - Class in com.puresoltechnologies.maven.plugins.license.internal

This method contains some helpers to deal with Artifacts.

B

buildArtifact(Artifact, Dependency) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyUtilities

This method builds a new Artifact from a Dependency.

C

canGenerateReport() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

com.puresoltechnologies.maven.plugins.license - package com.puresoltechnologies.maven.plugins.license

com.puresoltechnologies.maven.plugins.license.internal - package com.puresoltechnologies.maven.plugins.license.internal

com.puresoltechnologies.maven.plugins.license.parameter - package com.puresoltechnologies.maven.plugins.license.parameter

createDirectoryIfNotPresent(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method checks a directory for presence.

createFileIfNotPresent(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method checks a file for presence.

createNewResultsFile(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Creates a new and empty results file.

createNewSettingsFile(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Creates a new and empty settings file.

D

deleteFileIfPresent(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method checks the presence of a file.

DependencyTree - Class in com.puresoltechnologies.maven.plugins.license.internal

This class contains a dependency tree with all its transitive dependencies.

DependencyTree(Artifact, List<License>) - Constructor for class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

Initial value constructor.

DependencyUtilities - Class in com.puresoltechnologies.maven.plugins.license.internal

This method contains some helpers to deal with Dependency objects.

E

equals(Object) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

equals(Object) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

equals(Object) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

execute() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

execute() - Method in class com.puresoltechnologies.maven.plugins.license.ValidatorMojo

G

generate(Sink, Locale) - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getAliases() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Returns the KnownLicense.aliases Set.

getAllDependencies() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

This method puts all dependencies into a List.

getApprovedDependencies() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Returns the KnownLicense.approvedDependencies Set.

getArtifact() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

Returns the Artifact.

getArtifactId() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

getArtifactInformation() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

getArtifacts(boolean) - Method in class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

This method retrieves all artifacts of the current Maven module.

getCategoryName() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getClassifier() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

getComment() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

getDependencies() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

Returns the dependencies of the current DependencyTree.

getDescription(Locale) - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getGroupId() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

getIdentifier() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

This method returns the artifact identifier.

getLicense() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

getLicenses() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

Returns the license of this node.

getMavenProject() - Method in class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

This method returns the current MavenProject.

getName() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

This method returns the license name.

getName(Locale) - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getOriginalLicenseName() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

getOriginalLicenseURL() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

getOutputName() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getParent() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

Returns the parent of this dependency.

getProjectBuilder() - Method in class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

This method returns a MavenProjectBuilder.

getReportOutputDirectory() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

getResultsFile(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Returns the position of the results file.

getScope() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

getSettingsFile(Log, File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method checks and returns the position of the settings file.

getType() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

getUrl() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Returns the URL to the license text.

getVersion() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

H

hashCode() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

hashCode() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

hashCode() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

I

IOUtilities - Class in com.puresoltechnologies.maven.plugins.license.internal

This class contains some utilities for the license maven plugin.

isExternalReport() - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

isValid() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Set returns the KnownLicense.valid flag.

isValid() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

iterator() - Method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyTree

K

KnownLicense - Class in com.puresoltechnologies.maven.plugins.license.parameter

This class contains a single known license.

KnownLicense() - Constructor for class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

KnownLicense(String, URL, boolean, Set<String>, Set<String>) - Constructor for class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

L

LICENSE_RESULTS_FILE - Static variable in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

The constant for the license validation result file.

LICENSE_SETTINGS_FILE - Static variable in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This is the constant for the settings properties file.

loadArtifacts(boolean, boolean, boolean, boolean) - Method in class com.puresoltechnologies.maven.plugins.license.AbstractValidationMojo

This method retrieves all artifacts of the current Maven module.

O

outputDirectory - Variable in class com.puresoltechnologies.maven.plugins.license.ReportMojo

Specifies the destination directory where documentation is to be saved to.

R

readResult(BufferedReader) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Reads a single CSV line from a BufferedReader and converts it into a ValidationResult.

ReportMojo - Class in com.puresoltechnologies.maven.plugins.license

This maven mojo generates a license report out of information generated by a former 'validate' goal run.

ReportMojo() - Constructor for class com.puresoltechnologies.maven.plugins.license.ReportMojo

restoreObject(File) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method returns a former serialized object from a file.

S

setAliases(Set<String>) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Sets a new KnownLicense.aliases Set.

setApprovedDependencies(Set<String>) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

Sets a new KnownLicense.approvedDependencies Set.

setName(String) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

This method sets the license's name.

setReportOutputDirectory(File) - Method in class com.puresoltechnologies.maven.plugins.license.ReportMojo

setUrl(URL) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

This method sets a URL to the full license text.

setValid(boolean) - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

split(String) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

This method splits a single CSV line into junks of String.

storeObject(File, Serializable) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Stores any Serializable object into a file.

T

toString(Artifact) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.ArtifactUtilities

This method returns a string representing the Artifact given as parameter.

toString(Dependency) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.ArtifactUtilities

This method returns a string representing the Dependency given as parameter.

toString(Dependency) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.DependencyUtilities

This method returns a string representing the Dependency given as parameter.

toString() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.ArtifactInformation

This method returns the artifact identifier.

toString() - Method in class com.puresoltechnologies.maven.plugins.license.parameter.KnownLicense

V

ValidationResult - Class in com.puresoltechnologies.maven.plugins.license.parameter

This class contains the result of a license validation.

ValidationResult(ArtifactInformation, KnownLicense, String, URL, String, boolean) - Constructor for class com.puresoltechnologies.maven.plugins.license.parameter.ValidationResult

ValidatorMojo - Class in com.puresoltechnologies.maven.plugins.license

This class is a Maven Mojo to check the validity of licenses specified in the dependencies of a maven module.

ValidatorMojo() - Constructor for class com.puresoltechnologies.maven.plugins.license.ValidatorMojo

W

writeResult(Writer, ValidationResult) - Static method in class com.puresoltechnologies.maven.plugins.license.internal.IOUtilities

Writes a CSV file line with the given ValidationResult.

A B C D E G H I K L O R S T V W