A B C D E F G H I J K L M N O P R S T U V W X

A

AbstractAddThirdPartyMojo - Class in org.codehaus.mojo.license

Abstract mojo for all third-party mojos.

AbstractAddThirdPartyMojo() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

AbstractAddThirdPartyMojo.ExcludedLicenses - Class in org.codehaus.mojo.license

Class to fill the AbstractAddThirdPartyMojo.excludedLicenses parameter, from a simple string to split, or a list of string.

AbstractAddThirdPartyMojo.IncludedLicenses - Class in org.codehaus.mojo.license

Class to fill the AbstractAddThirdPartyMojo.includedLicenses parameter, from a simple string to split, or a list of string.

AbstractDownloadLicensesMojo - Class in org.codehaus.mojo.license

Created on 23/05/16.

AbstractDownloadLicensesMojo() - Constructor for class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

AbstractDownloadLicensesMojo.ErrorRemedy - Enum in org.codehaus.mojo.license

What to do in case of a license download error.

AbstractFileHeaderMojo - Class in org.codehaus.mojo.license

Abstract mojo for file-header operations (check, update, report,...).

AbstractFileHeaderMojo() - Constructor for class org.codehaus.mojo.license.AbstractFileHeaderMojo

AbstractFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Abstract implementation of FileHeaderTransformer.

AbstractFileHeaderTransformer(String, String, String, String, String) - Constructor for class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

AbstractLicenseMojo - Class in org.codehaus.mojo.license

Abstract license mojo.

AbstractLicenseMojo() - Constructor for class org.codehaus.mojo.license.AbstractLicenseMojo

AbstractLicenseNameMojo - Class in org.codehaus.mojo.license

Abstract mojo which using a AbstractLicenseNameMojo.licenseName and owns a AbstractLicenseNameMojo.licenseStore.

AbstractLicenseNameMojo() - Constructor for class org.codehaus.mojo.license.AbstractLicenseNameMojo

AbstractLicenseReportRenderer - Class in org.codehaus.mojo.license

Base class for report renderers.

AbstractLicenseReportRenderer(Sink, String, I18N, Locale) - Constructor for class org.codehaus.mojo.license.AbstractLicenseReportRenderer

AbstractLicensesXmlMojo - Class in org.codehaus.mojo.license

A common parent for LicensesXmlInsertVersionsMojo and AbstractDownloadLicensesMojo.

AbstractLicensesXmlMojo() - Constructor for class org.codehaus.mojo.license.AbstractLicensesXmlMojo

AbstractThirdPartyReportMojo - Class in org.codehaus.mojo.license

Base class for third-party reports.

AbstractThirdPartyReportMojo() - Constructor for class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

acceptPackaging(String...) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Accept the project's packaging between some given.

acceptPomPackaging - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

If true the mojo will be executed for reactor projects having any packaging (including pom); otherwise the mojo will be executed only for projects that do not have packaging pom.

addDownloaderMessage(String) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

addEntryToList(String) - Method in class org.codehaus.mojo.license.utils.StringToList

addFile(File, EnumMap<FileState, Set<File>>) - Method in enum org.codehaus.mojo.license.FileState

Register a file for this state on result dictionary.

addHeader(String) - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

addHeader(String, String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Adds the header.

addHeader(String, String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Adds the header.

addHeader(String, String) - Method in class org.codehaus.mojo.license.header.transformer.HtmlFileHeaderTransformer

Adds the header.

addHeader(String, String) - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Adds the header.

addHeader(String, String) - Method in class org.codehaus.mojo.license.header.transformer.PropertiesFileHeaderTransformer

Adds the header.

addHeader(String, String) - Method in class org.codehaus.mojo.license.header.transformer.XmlFileHeaderTransformer

Adds the header.

addJarRepository() - Method in class org.codehaus.mojo.license.model.LicenseStore

addJavaLicenseAfterPackage - Variable in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Flag to add the license header after the package statement.

addLicense(LicenseMap, MavenProject, String...) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Add one or more licenses (name and url are licenseNames) to the given licenseMap for the given project.

addLicense(LicenseMap, MavenProject, License) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Add a given license to the given licenseMap for the given project.

addLicense(LicenseMap, MavenProject, List<?>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Add a given licenses to the given licenseMap for the given project.

addLicense(LicenseMap, MavenProject, String...) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Add one or more licenses (name and url are licenseNames) to the given licenseMap for the given project.

addLicense(LicenseMap, MavenProject, License) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Add a given license to the given licenseMap for the given project.

addLicense(LicenseMap, MavenProject, List<?>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Add a given licenses to the given licenseMap for the given project.

addLicense(ProjectLicense) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

addMatchLicense(ProjectLicense) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

addRepository(String) - Method in class org.codehaus.mojo.license.model.LicenseStore

addRepository(URL) - Method in class org.codehaus.mojo.license.model.LicenseStore

addRepository(LicenseRepository) - Method in class org.codehaus.mojo.license.model.LicenseStore

addResourceDir(File, String...) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Add a new resource location to the maven project (in not already present).

addResourceDir(File, MavenProject, String...) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

Add the directory as a resource of the given project.

addResourceDir(File, MavenProject, List<?>, String...) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

Add the directory as a resource in the given resource list.

addRootPackageClassPathRepository() - Method in class org.codehaus.mojo.license.model.LicenseStore

AddThirdPartyMojo - Class in org.codehaus.mojo.license

Goal to generate the third-party license file.

AddThirdPartyMojo() - Constructor for class org.codehaus.mojo.license.AddThirdPartyMojo

afterExecute() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

A call back to execute after the AbstractLicenseMojo.execute() is done.

AggregateDownloadLicensesMojo - Class in org.codehaus.mojo.license

Download the license files of all aggregated dependencies of the current project, and generate a summary file containing a list of all dependencies and their licenses.

AggregateDownloadLicensesMojo() - Constructor for class org.codehaus.mojo.license.AggregateDownloadLicensesMojo

AggregatorAddThirdPartyMojo - Class in org.codehaus.mojo.license

This goal forks executions of the add-third-party goal for all the leaf projects of the tree of modules below the point where it is executed.

AggregatorAddThirdPartyMojo() - Constructor for class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

AggregatorThirdPartyReportMojo - Class in org.codehaus.mojo.license

Generates a report of all third-parties detected in the module.

AggregatorThirdPartyReportMojo() - Constructor for class org.codehaus.mojo.license.AggregatorThirdPartyReportMojo

applies(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

AptFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for apt format.

AptFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.AptFileHeaderTransformer

Default constructor.

ArtifactFilters - Class in org.codehaus.mojo.license.api

Artifact filtering by groupId:artifactId regular expression includes/excludes Scope includes/excludes Type includes/excludes

ArtifactFilters(ArtifactFilters.IncludesExcludes, ArtifactFilters.IncludesExcludes, ArtifactFilters.IncludesExcludes, boolean) - Constructor for class org.codehaus.mojo.license.api.ArtifactFilters

ArtifactFilters.Builder - Class in org.codehaus.mojo.license.api

An ArtifactFilters builder.

artifactFiltersUrl - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A URL returning a plain text file that contains include/exclude artifact filters in the following format:

attachThirdPartyDescriptor(File) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Attach the third-party descriptor to the build.

attachThirdPartyDescriptor(MavenProject, File) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

For the given project, attach the given file as a third-party file.

attachThirdPartyDescriptor(File) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Attach the third-party descriptor to the build.

attachThirdPartyDescriptor(MavenProject, File) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

For the given project, attach the given file as a third-party file.

autodetect(Path, Charset) - Static method in enum org.codehaus.mojo.license.Eol

B

backupFile(File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Backups the given file using the FileUtil.getBackupFile(File) as destination file.

baseURL - Variable in class org.codehaus.mojo.license.model.License

base url of license (directory where to find license files).

baseURL - Variable in class org.codehaus.mojo.license.model.LicenseRepository

the base url of the licenses repository.

boxComment(String, boolean) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Box the given header in a comment.

boxComment(String, boolean) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Box the given header in a comment.

boxProcessTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Box the given header between process tags.

boxProcessTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Box the given header between process tags.

buidler() - Static method in class org.codehaus.mojo.license.api.ArtifactFilters

build() - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

build() - Method in class org.codehaus.mojo.license.download.LicensedArtifact.Builder

build() - Method in class org.codehaus.mojo.license.download.LicenseMatchers.Builder

build(File, Map<String, String>, Log) - Static method in class org.codehaus.mojo.license.download.PreferredFileNames

build() - Method in class org.codehaus.mojo.license.download.UrlReplacements.Builder

build() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

build() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

Builder() - Constructor for class org.codehaus.mojo.license.api.ArtifactFilters.Builder

builder(String, String, String) - Static method in class org.codehaus.mojo.license.download.LicensedArtifact

Builder(String, String, String) - Constructor for class org.codehaus.mojo.license.download.LicensedArtifact.Builder

builder() - Static method in class org.codehaus.mojo.license.download.LicenseMatchers

Builder() - Constructor for class org.codehaus.mojo.license.download.LicenseMatchers.Builder

builder(Log) - Static method in class org.codehaus.mojo.license.download.UrlReplacements

Builder(Log) - Constructor for class org.codehaus.mojo.license.download.UrlReplacements.Builder

builder() - Static method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

Builder() - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

builder() - Static method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

Builder() - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

bundleLicensePath - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

The path of the bundled license file to produce when UpdateProjectLicenseMojo.generateBundle is on.

bundleName - Variable in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

The name of the bundle containing our I18n resources.

bundleThirdPartyPath - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

The path of the bundled third party file to produce when AbstractAddThirdPartyMojo.generateBundle is on.

C

Cache - Class in org.codehaus.mojo.license.download

A simple HashMap based in-memory cache for storing LicenseDownloader.LicenseDownloadResults.

Cache(boolean) - Constructor for class org.codehaus.mojo.license.download.Cache

canGenerateReport() - Method in class org.codehaus.mojo.license.AggregatorThirdPartyReportMojo

canGenerateReport() - Method in class org.codehaus.mojo.license.ThirdPartyReportMojo

changeState(DefaultFilter.State) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

checkEncoding() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Method to be invoked in init phase to check sanity of AbstractLicenseMojo.getEncoding().

checkExists(URL) - Method in class org.codehaus.mojo.license.model.LicenseRepository

CheckFileHeaderMojo - Class in org.codehaus.mojo.license

The goal to check if the state of header on project source files.

CheckFileHeaderMojo() - Constructor for class org.codehaus.mojo.license.CheckFileHeaderMojo

checkInit(String) - Method in class org.codehaus.mojo.license.model.LicenseRepository

checkInit(String) - Method in class org.codehaus.mojo.license.model.LicenseStore

checkNotInit(String) - Method in class org.codehaus.mojo.license.model.LicenseRepository

checkNotInit(String) - Method in class org.codehaus.mojo.license.model.LicenseStore

checkPackaging() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Check if the project packaging is acceptable for the mojo.

checkPackaging() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Check if the project packaging is acceptable for the mojo.

checkPackaging() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

Check if the project packaging is acceptable for the mojo.

checkSkip() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Checks if the mojo execution should be skipped.

checkSkip() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Checks if the mojo execution should be skipped.

checkSkip() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

Checks if the mojo execution should be skipped.

CLASSPATH_PROTOCOL - Static variable in class org.codehaus.mojo.license.model.LicenseStore

Classpath protocol prefix for extra license resolver to seek in classpath.

CLASSPATH_PROTOCOL - Static variable in class org.codehaus.mojo.license.utils.UrlRequester

clone() - Method in class org.codehaus.mojo.license.download.ProjectLicense

cloneLicenses() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

close() - Method in class org.codehaus.mojo.license.download.LicenseDownloader

CommentStyleListMojo - Class in org.codehaus.mojo.license

Displays all the available comment style to box file headers.

CommentStyleListMojo() - Constructor for class org.codehaus.mojo.license.CommentStyleListMojo

compile(String, String, String, String) - Static method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

compile(String, String, String) - Static method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement

ContentSanitizer(String, Pattern, Pattern, String) - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

contentSanitizer(String, String, String, String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

convert(long, double[], String[]) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

convertTime(long) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

copyFile(File, File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Copy a file to a given locationand logging.

copyright - Variable in class org.codehaus.mojo.license.header.FileHeader

Copyright model.

Copyright - Class in org.codehaus.mojo.license.model

Model of a copyright.

Copyright() - Constructor for class org.codehaus.mojo.license.model.Copyright

Copyright(Copyright) - Constructor for class org.codehaus.mojo.license.model.Copyright

Copyright(int, Integer, String) - Constructor for class org.codehaus.mojo.license.model.Copyright

COPYRIGHT_TO_STRING_FORMAT - Static variable in class org.codehaus.mojo.license.model.Copyright

Copyright to string format.

copyrightOwners - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

optional copyright owners.

createDependencyNode(Document, ProjectLicenseInfo, boolean) - Static method in class org.codehaus.mojo.license.download.LicenseSummaryWriter

createDirectoryIfNecessary(File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Creates the directory (and his parents) if necessary.

createLicenseMap(SortedMap<String, MavenProject>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Creates a license map from given dependencies.

createLicenseMap(SortedMap<String, MavenProject>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Creates a license map from given dependencies.

createLicenseNode(Document, ProjectLicense, boolean) - Static method in class org.codehaus.mojo.license.download.LicenseSummaryWriter

createLicenseStore(Log, String...) - Static method in class org.codehaus.mojo.license.model.LicenseStore

createNewFile(File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

createThirdPartyDetails() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

createThirdPartyDetails() - Method in class org.codehaus.mojo.license.AggregatorThirdPartyReportMojo

createThirdPartyDetails() - Method in class org.codehaus.mojo.license.ThirdPartyReportMojo

createUnsafeMapping() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Creates the unsafe mapping (says dependencies with no license given by their pom).

createUnsafeMapping() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Creates the unsafe mapping (says dependencies with no license given by their pom).

createUnsafeMapping() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

Creates the unsafe mapping (says dependencies with no license given by their pom).

createUnsafeMapping(LicenseMap, File, String, boolean, SortedSet<MavenProject>, SortedMap<String, MavenProject>, Set<Artifact>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Loads unsafe mappings.

createUnsafeMapping(LicenseMap, File, String, boolean, SortedSet<MavenProject>, SortedMap<String, MavenProject>, Set<Artifact>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Loads unsafe mappings.

D

deepEquals(ProjectLicenseInfo) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

DEFAULT_EXCLUDES - Static variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

DEFAULT_INCLUDES - Static variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

DEFAULT_PROCESS_END_TAG - Static variable in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

default process end tag.

DEFAULT_PROCESS_START_TAG - Static variable in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

default process start tag.

DEFAULT_ROOTS - Static variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

DEFAULT_SECTION_DELIMITER - Static variable in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

default section delimiter.

DefaultThirdPartyDetails - Class in org.codehaus.mojo.license.api

Default implementation of ThirdPartyDetails.

DefaultThirdPartyDetails(MavenProject) - Constructor for class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

DefaultThirdPartyHelper - Class in org.codehaus.mojo.license.api

Default implementation of the ThirdPartyHelper.

DefaultThirdPartyHelper(MavenProject, String, boolean, DependenciesTool, ThirdPartyTool, ArtifactRepository, List<ArtifactRepository>, Log) - Constructor for class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Constructor of the helper.

DefaultThirdPartyTool - Class in org.codehaus.mojo.license.api

Default implementation of the third party tool.

DefaultThirdPartyTool() - Constructor for class org.codehaus.mojo.license.api.DefaultThirdPartyTool

deleteFile(File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Delete the given file.

dependencies - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

The set of dependencies for the current project, used to locate license databases.

dependenciesTool - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Dependencies tool.

dependenciesTool - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

Dependencies tool.

DependenciesTool - Class in org.codehaus.mojo.license.api

A tool to deal with dependencies of a project.

DependenciesTool() - Constructor for class org.codehaus.mojo.license.api.DependenciesTool

DependenciesToolException - Exception in org.codehaus.mojo.license.api

Created on 23/05/16.

DependenciesToolException(Throwable) - Constructor for exception org.codehaus.mojo.license.api.DependenciesToolException

deployMissingFile - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Attach the 'missing' file as an additional artifact so that it is deployed in the deploy phase.

description - Variable in class org.codehaus.mojo.license.header.FileHeader

Description of the project or module to add in header.

description - Variable in class org.codehaus.mojo.license.model.License

the description of the license.

detailsUrl(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

detectHeader - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

flag set to true as soon as start process tag was detected.

doAction() - Method in class org.codehaus.mojo.license.AbstractFileHeaderMojo

doAction() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Do plugin action.

doAction() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Do plugin action.

doAction() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

Do plugin action.

doAction() - Method in class org.codehaus.mojo.license.CommentStyleListMojo

Do plugin action.

doAction() - Method in class org.codehaus.mojo.license.LicenseListMojo

Do plugin action.

doAction() - Method in class org.codehaus.mojo.license.RemoveFileHeaderMojo

doAction() - Method in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

Do plugin action.

doGenerate - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Flag computed in the AbstractAddThirdPartyMojo.init() method to know if there is something has to be generated.

doGenerateBundle - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Flag computed in the AbstractAddThirdPartyMojo.init() method to know if a bundle version has to be generated.

downloadLicense(String, FileNameEntry, Log) - Method in class org.codehaus.mojo.license.download.LicenseDownloader

Downloads a license file from the given licenseUrlString stores it locally and returns the local path where the license file was stored.

DownloadLicensesMojo - Class in org.codehaus.mojo.license

Download the license files of all the current project's dependencies, and generate a summary file containing a list of all dependencies and their licenses.

DownloadLicensesMojo() - Constructor for class org.codehaus.mojo.license.DownloadLicensesMojo

downloadList(String) - Static method in class org.codehaus.mojo.license.utils.UrlRequester

will download a external resource and read the content of the file that will then be translated into a new list.

E

encoding - Variable in class org.codehaus.mojo.license.utils.SortedProperties

l'encoding a utiliser pour lire et ecrire le properties.

Eol - Enum in org.codehaus.mojo.license

End of line values

equals(Object) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

equals(Object) - Method in class org.codehaus.mojo.license.download.LicensedArtifact

equals(Object) - Method in class org.codehaus.mojo.license.download.ProjectLicense

equals(Object) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

equals(Object) - Method in class org.codehaus.mojo.license.model.Copyright

errorMessage(String) - Method in class org.codehaus.mojo.license.download.LicensedArtifact.Builder

errorRemedy - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

What to do on any license download related error.

excludedArtifacts - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A regular expression (not glob pattern) used as filter to exclude artifacts that have matching artifactId.

excludedGroups - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A regular expression (not glob pattern) used as filter to exclude artifacts that have matching groupId.

excludedLicenses - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

To specify some licenses to exclude.

ExcludedLicenses() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.ExcludedLicenses

Default constructor used when AbstractAddThirdPartyMojo.excludedLicenses parameter is configured by a list.

excludedScopes - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A comma separated list of scopes to exclude: e.g.

excludedTypes - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A comma separated list of types to exclude: e.g.

excludeGa(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeGas(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeScope(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeScopes(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeScopes(Collection<String>) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeType(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeTypes(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

excludeTypes(Collection<String>) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

execute() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

execute() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

execute() - Method in class org.codehaus.mojo.license.HelpMojo

execute() - Method in class org.codehaus.mojo.license.LicensesXmlInsertVersionsMojo

executeReport(Locale) - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

extraTemplateParameters - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

optional extra templates parameters.

F

failIfWarning - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Deprecated.

since 1.14, use now AbstractAddThirdPartyMojo.failOnMissing or AbstractAddThirdPartyMojo.failOnBlacklist.

failOnBlacklist - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A flag to fail the build if at least one dependency was blacklisted.

failOnMissing - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A flag to fail the build if at least one dependency was detected without a license.

failure(String) - Static method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

FileHeader - Class in org.codehaus.mojo.license.header

Contract of a file header.

FileHeader() - Constructor for class org.codehaus.mojo.license.header.FileHeader

fileHeader - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

incoming default file header model.

FileHeaderFilter - Class in org.codehaus.mojo.license.header

File Header filter.

FileHeaderFilter() - Constructor for class org.codehaus.mojo.license.header.FileHeaderFilter

Default constructor.

FileHeaderProcessor - Class in org.codehaus.mojo.license.header

File header processor.

FileHeaderProcessor(FileHeaderFilter, FileHeader, FileHeaderTransformer) - Constructor for class org.codehaus.mojo.license.header.FileHeaderProcessor

FileHeaderTransformer - Interface in org.codehaus.mojo.license.header.transformer

Contract to transform a file header to FileHeader in both way : Obtain a object representation of a file header from a existing file (String to FileHeader). Obtain the file header to inject in a file from a FileHeader (to update or create a file header from the file header model).

FileNameEntry - Class in org.codehaus.mojo.license.download

A triple consiting of a File, its SHA-1 checksum and a boolean whether FileNameEntry.file's name comes from PreferredFileNames and is thus preferred.

FileNameEntry(File, boolean, String) - Constructor for class org.codehaus.mojo.license.download.FileNameEntry

FileState - Enum in org.codehaus.mojo.license

Defines state of a file after process.

fileTemplate - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Template used to build the third-party file.

FileUtil - Class in org.codehaus.mojo.license.utils

Some basic file io utilities

FileUtil() - Constructor for class org.codehaus.mojo.license.utils.FileUtil

firstYear - Variable in class org.codehaus.mojo.license.model.Copyright

Copyright first year of application.

force - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

To force generation of the third-party file even if everything is up to date.

force - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

A flag to force to generate project license file even if it is up-to-date.

freemarkerConfiguration - Variable in class org.codehaus.mojo.license.api.FreeMarkerHelper

Shared freemarker configuration.

FreeMarkerFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for freemarker format.

FreeMarkerFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.FreeMarkerFileHeaderTransformer

Default constructor.

FreeMarkerHelper - Class in org.codehaus.mojo.license.api

A helper to deal with freemarker templating.

FreeMarkerHelper(TemplateLoader) - Constructor for class org.codehaus.mojo.license.api.FreeMarkerHelper

fullHeaderContent - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

cached full header content (with process tag + comment box).

G

generateBundle - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A flag to copy a bundled version of the third-party file.

generateBundle - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

A flag to copy the main license file in a bundled place.

get(String) - Method in class org.codehaus.mojo.license.download.Cache

getAllDependencies() - Method in class org.codehaus.mojo.license.api.ResolvedProjectDependencies

getArtifactCache() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Obtains the cache of loaded dependencies indexed by their gav.

getArtifactCache() - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Obtains the cache of loaded dependencies indexed by their gav.

getArtifactFilters() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

getArtifactFilters() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getArtifactFilters() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

getArtifactFilters() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

getArtifactFiltersUrl() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getArtifactId() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getArtifactId() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getArtifactId() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

getArtifactId() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getArtifactId(Artifact) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

getArtifactName(MavenProject) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

getAttachments() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getAttachments() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

getAutodetectEolFiles() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

getAutodetectEolFiles() - Method in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

getAutodetectEolFiles() - Method in class org.codehaus.mojo.license.LicensesXmlInsertVersionsMojo

getBackupFile(File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

getBaseURL() - Method in class org.codehaus.mojo.license.model.License

getBaseURL() - Method in class org.codehaus.mojo.license.model.LicenseRepository

getBuildTimestamp() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

getClassifier() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getClassifier() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getCommentEndTag() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getCommentEndTag() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getCommentLinePrefix() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getCommentLinePrefix() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getComments() - Method in class org.codehaus.mojo.license.download.License

getComments() - Method in class org.codehaus.mojo.license.download.ProjectLicense

Get addendum information pertaining to this license.

getCommentStartTag() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getCommentStartTag() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getCommentStartTag() - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

getContentPattern() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

getContentRegexp() - Method in class org.codehaus.mojo.license.LicenseContentSanitizer

getContentReplacement() - Method in class org.codehaus.mojo.license.LicenseContentSanitizer

getContentReplacement() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

getContentSanitizers() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments

getCopyright() - Method in class org.codehaus.mojo.license.header.FileHeader

getCopyrightOwners() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

getData() - Method in class org.codehaus.mojo.license.utils.StringToList

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.AptFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.FreeMarkerFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.HtmlFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.JspFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.MySqlFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.PhpFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.PropertiesFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.RstFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.SqlFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefaultAcceptedExtensions() - Method in class org.codehaus.mojo.license.header.transformer.XmlFileHeaderTransformer

Get the default accepted extensions for this transformer.

getDefinitionURL() - Method in class org.codehaus.mojo.license.model.LicenseRepository

getDefinitionURL() - Method in class org.codehaus.mojo.license.model.RootPackageClassPathLicenseRepository

getDependencies() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

getDependencies() - Method in class org.codehaus.mojo.license.AggregateDownloadLicensesMojo

getDependencies() - Method in class org.codehaus.mojo.license.DownloadLicensesMojo

getDescription(Locale) - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getDescription() - Method in class org.codehaus.mojo.license.header.FileHeader

getDescription() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getDescription() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getDescription() - Method in class org.codehaus.mojo.license.model.License

getDetailsUrl() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getDirectDependencies() - Method in class org.codehaus.mojo.license.api.ResolvedProjectDependencies

getDistribution() - Method in class org.codehaus.mojo.license.download.License

getDistribution() - Method in class org.codehaus.mojo.license.download.ProjectLicense

Get the primary method by which this project may be distributed.

getDownloaderMessages() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getEncoding() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

getEncoding() - Method in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

getEncoding() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getEntryByUrl(String) - Method in class org.codehaus.mojo.license.download.PreferredFileNames

getEolString() - Method in enum org.codehaus.mojo.license.Eol

getErrorMessage() - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

getErrorMessages() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

getFile() - Method in class org.codehaus.mojo.license.download.FileNameEntry

getFile() - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

getFile() - Method in class org.codehaus.mojo.license.download.ProjectLicense

Returns the name of the license file (without path) downloaded from ProjectLicense.url.

getFile(File, String...) - Static method in class org.codehaus.mojo.license.utils.FileUtil

getFileHeader() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getFileHeaderDescription() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

getFileNameBySha1(String) - Method in class org.codehaus.mojo.license.download.PreferredFileNames

getFileURL(License, String) - Method in class org.codehaus.mojo.license.model.LicenseRepository

getFirstYear() - Method in class org.codehaus.mojo.license.model.Copyright

getFooter() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getFromUrl(String) - Static method in class org.codehaus.mojo.license.utils.UrlRequester

Returns the content of the resource pointed by the given URL as a string.

getFromUrl(String, String) - Static method in class org.codehaus.mojo.license.utils.UrlRequester

Returns the content of the resource pointed by the given URL as a string.

getFullHeaderContent() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getGAV(ThirdPartyDetails) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

getGroupId() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getGroupId() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getGroupId() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

getGroupId() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getHeader() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getHeaderContent() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getHeaderContent(String) - Method in class org.codehaus.mojo.license.model.License

getHeaderURL() - Method in class org.codehaus.mojo.license.model.License

getHelper() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

getHolder() - Method in class org.codehaus.mojo.license.model.Copyright

getId() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

The unique ID for the project

getId() - Method in class org.codehaus.mojo.license.LicenseContentSanitizer

getId() - Method in class org.codehaus.mojo.license.LicenseUrlReplacement

getId() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

getId() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement

getLastYear() - Method in class org.codehaus.mojo.license.model.Copyright

getLatest() - Static method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

getLicense(String, boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

getLicense() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

getLicense() - Method in class org.codehaus.mojo.license.header.FileHeader

getLicense(String) - Method in class org.codehaus.mojo.license.model.LicenseRepository

getLicense(String) - Method in class org.codehaus.mojo.license.model.LicenseStore

getLicenseBaseURL(String) - Method in class org.codehaus.mojo.license.model.LicenseRepository

getLicenseBaseURL(String) - Method in class org.codehaus.mojo.license.model.RootPackageClassPathLicenseRepository

getLicenseContent(String) - Method in class org.codehaus.mojo.license.model.License

getLicenseId() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getLicenseListVersion() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

getLicenseName() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

getLicenseNames() - Method in class org.codehaus.mojo.license.model.LicenseRepository

getLicenseNames() - Method in class org.codehaus.mojo.license.model.LicenseStore

getLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getLicenses() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

getLicenses() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getLicenses() - Method in class org.codehaus.mojo.license.model.LicenseRepository

getLicenses() - Method in class org.codehaus.mojo.license.model.LicenseStore

getLicenses() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

getLicenseURL() - Method in class org.codehaus.mojo.license.model.License

getLineSeparator() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getLineSeparator() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getLog() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getMatchLicenses() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getMimeType() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo

getName(Locale) - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getName() - Method in class org.codehaus.mojo.license.download.License

getName() - Method in class org.codehaus.mojo.license.download.ProjectLicense

Get the full legal name of the license.

getName() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

getName() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

getName() - Method in class org.codehaus.mojo.license.model.License

getName() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getNewHeader(FileHeader) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

Obtains the new header to use according to the old one.

getNewHeader(FileHeader) - Method in class org.codehaus.mojo.license.header.UpdateFileHeaderFilter

getOutputDirectory() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getOutputName() - Method in class org.codehaus.mojo.license.AggregatorThirdPartyReportMojo

getOutputName() - Method in class org.codehaus.mojo.license.ThirdPartyReportMojo

getParams(String) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

getPattern() - Method in class org.codehaus.mojo.license.LicenseUrlReplacement

getPomLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getPomLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getProcessEndTag() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Obtain the process tag which indiciates the end of the header content.

getProcessEndTag() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Obtain the process tag which indiciates the end of the header content.

getProcessStartTag() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Obtains the process tag which indicates the begin of the header content.

getProcessStartTag() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Obtains the process tag which indicates the begin of the header content.

getProcessTagHeaderContent() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getProject() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

getProject() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

getProject() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getProjectName(MavenProject) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

getProjectsWithNoLicense(LicenseMap) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Obtains all dependencies with no license form the given license map.

getProjectsWithNoLicense(LicenseMap, boolean) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

From the given licenseMap, obtain all the projects with no license.

getProjectsWithNoLicense(LicenseMap) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Obtains all dependencies with no license form the given license map.

getProjectsWithNoLicense(LicenseMap, boolean) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

From the given licenseMap, obtain all the projects with no license.

getReference() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getRegexp() - Method in class org.codehaus.mojo.license.LicenseUrlReplacement

getReleaseDate() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList

getReplacement() - Method in class org.codehaus.mojo.license.LicenseUrlReplacement

getReplacement() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement

getRepositories() - Method in class org.codehaus.mojo.license.model.LicenseStore

getScope() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getScope() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getSectionDelimiter() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

The pattern used to separate sections of the header.

getSectionDelimiter() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

The pattern used to separate sections of the header.

getSeeAlso() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

getSession() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

getSha1() - Method in class org.codehaus.mojo.license.download.FileNameEntry

getSha1() - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

getSha1() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo

getSiteRenderer() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

getTemplate(String) - Method in class org.codehaus.mojo.license.api.FreeMarkerHelper

getText(String) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

Gets the localized message for this report.

getText() - Method in class org.codehaus.mojo.license.model.Copyright

Produces a string representation of the copyright.

getThirdPartiesNoLicense() - Method in class org.codehaus.mojo.license.ThirdPartyReportRenderer

getThirdPartiesPomLicense() - Method in class org.codehaus.mojo.license.ThirdPartyReportRenderer

getThirdPartiesThirdPartyLicense() - Method in class org.codehaus.mojo.license.ThirdPartyReportRenderer

getThirdPartyLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getThirdPartyLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getTitle() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

getTransformer() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

getType() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getType() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getUrl() - Method in class org.codehaus.mojo.license.download.License

getUrl() - Method in class org.codehaus.mojo.license.download.ProjectLicense

Get the official url for the license text.

getUrl(URL, String) - Static method in class org.codehaus.mojo.license.utils.MojoHelper

suffix a given baseUrl with the given suffix

getUrlInfos() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments

getUrlPattern() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

getUrlPattern() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement

getUrlRegexp() - Method in class org.codehaus.mojo.license.LicenseContentSanitizer

getUrlReplacements() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments

getVersion() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

getVersion() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

getVersion() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

getVersion() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

getYears() - Method in class org.codehaus.mojo.license.model.Copyright

Produces a string representation of the copyright year range.

H

hasClassPath() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

hashCode() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

hashCode() - Method in class org.codehaus.mojo.license.download.LicensedArtifact

hashCode() - Method in class org.codehaus.mojo.license.download.ProjectLicense

hashCode() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

hashCode() - Method in class org.codehaus.mojo.license.model.Copyright

hasLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

hasLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

hasMatchLicenses() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

hasPomLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

hasPomLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

hasThirdPartyLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

hasThirdPartyLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

headerContent - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

cached header content.

headerURL - Variable in class org.codehaus.mojo.license.model.License

url of the license header's content.

HelpMojo - Class in org.codehaus.mojo.license

Display help information on license-maven-plugin.
Call mvn license:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.codehaus.mojo.license.HelpMojo

holder - Variable in class org.codehaus.mojo.license.model.Copyright

Copyright holder.

HtmlFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for html format.

HtmlFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.HtmlFileHeaderTransformer

Default constructor.

I

i18n - Variable in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

Internationalization component.

inceptionYear - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

Inception year of the project.

includedArtifacts - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A regular expression (not glob pattern) used as filter to include only artifacts that have matching artifactId.

includedGroups - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A regular expression (not glob pattern) used as filter to include only artifacts that have matching groupId.

includedLicenses - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

To specify some licenses to include.

IncludedLicenses() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedLicenses

Default constructor used when AbstractAddThirdPartyMojo.includedLicenses parameter is configured by a list.

includedScopes - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A comma separated list of scopes to include: e.g.

includedTypes - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A comma separated list of types to include.

includeGa(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeGas(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeOptional(boolean) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeScope(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeScopes(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeScopes(Collection<String>) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeType(String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeTypes(String...) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

includeTypes(Collection<String>) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

init() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Method to initialize the mojo before doing any concrete actions.

init() - Method in class org.codehaus.mojo.license.AbstractFileHeaderMojo

init() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Method to initialize the mojo before doing any concrete actions.

init() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

Method to initialize the mojo before doing any concrete actions.

init() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

Method to initialize the mojo before doing any concrete actions.

init() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

init() - Method in class org.codehaus.mojo.license.CommentStyleListMojo

Method to initialize the mojo before doing any concrete actions.

init() - Method in class org.codehaus.mojo.license.LicenseListMojo

Method to initialize the mojo before doing any concrete actions.

init - Variable in class org.codehaus.mojo.license.model.LicenseRepository

flag to known if repository was init (pass to true when invoking the method LicenseRepository.load()).

init - Variable in class org.codehaus.mojo.license.model.LicenseStore

flag to know if store was init.

init() - Method in class org.codehaus.mojo.license.model.LicenseStore

init() - Method in class org.codehaus.mojo.license.RemoveFileHeaderMojo

init() - Method in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

Method to initialize the mojo before doing any concrete actions.

INVALID_PATTERN_MESSAGE - Static variable in class org.codehaus.mojo.license.api.DependenciesTool

Message used when an invalid expression pattern is found.

INVALID_PATTERN_MESSAGE - Static variable in class org.codehaus.mojo.license.download.LicensedArtifactResolver

Message used when an invalid expression pattern is found.

InvalideFileHeaderException - Exception in org.codehaus.mojo.license.header

Exception to be thrown when a file header could not be read or transformed back to a FileHeader

InvalideFileHeaderException() - Constructor for exception org.codehaus.mojo.license.header.InvalideFileHeaderException

Default constructor.

InvalideFileHeaderException(String) - Constructor for exception org.codehaus.mojo.license.header.InvalideFileHeaderException

Constructor with a message.

isApproved() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

isCopyrightEquals(FileHeader, FileHeader) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Tests if the copyright of the two models are equals.

isCopyrightEquals(FileHeader, FileHeader) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Tests if the copyright of the two models are equals.

isDeprecatedLicenseId(boolean) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

isDeprecatedLicenseId() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

isDescriptionEquals(FileHeader, FileHeader) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Tests if the description of the two models are equals.

isDescriptionEquals(FileHeader, FileHeader) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Tests if the description of the two models are equals.

isDetectHeader() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

isDetectHeader() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

isDryRun() - Method in class org.codehaus.mojo.license.AbstractFileHeaderMojo

isDryRun() - Method in class org.codehaus.mojo.license.CheckFileHeaderMojo

isDryRun() - Method in class org.codehaus.mojo.license.UpdateFileHeaderMojo

isEmptyLineAfterHeader() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Get flag if there should be an empty line after the header.

isEmptyLineAfterHeader() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Get flag if there should be an empty line after the header.

isExcludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

isExcludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

isExcludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

isExcludeTransitiveDependencies() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

isFailOnMissingHeader() - Method in class org.codehaus.mojo.license.AbstractFileHeaderMojo

isFailOnMissingHeader() - Method in class org.codehaus.mojo.license.CheckFileHeaderMojo

isFailOnMissingHeader() - Method in class org.codehaus.mojo.license.UpdateFileHeaderMojo

isFailOnNotUptodateHeader() - Method in class org.codehaus.mojo.license.AbstractFileHeaderMojo

isFailOnNotUptodateHeader() - Method in class org.codehaus.mojo.license.CheckFileHeaderMojo

isFailOnNotUptodateHeader() - Method in class org.codehaus.mojo.license.UpdateFileHeaderMojo

isFsfLibre(boolean) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

isFsfLibre() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

isHeaderContentTemplateAware() - Method in class org.codehaus.mojo.license.model.License

isIncluded(Artifact) - Method in class org.codehaus.mojo.license.api.ArtifactFilters

isIncludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

isIncludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

isIncludeTransitiveDependencies() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

isIncludeTransitiveDependencies() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

isKeepBackup() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

isLicenseContentTemplateAware() - Method in class org.codehaus.mojo.license.model.License

isLicenseEquals(FileHeader, FileHeader) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Tests if the license of the two models are equals.

isLicenseEquals(FileHeader, FileHeader) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Tests if the license of the two models are equals.

isModified() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

isModified() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

isOsiApproved(boolean) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

isOsiApproved() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

isPreferred() - Method in class org.codehaus.mojo.license.download.FileNameEntry

isPreferredFileName() - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

isSanitized() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo

isSkip() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

isSkip() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

When is sets to true, will skip execution.

isSkip() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

When is sets to true, will skip execution.

isSkip() - Method in class org.codehaus.mojo.license.AggregateDownloadLicensesMojo

isSkip() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

When is sets to true, will skip execution.

isSkip() - Method in class org.codehaus.mojo.license.CheckFileHeaderMojo

isSkip() - Method in class org.codehaus.mojo.license.CommentStyleListMojo

When is sets to true, will skip execution.

isSkip() - Method in class org.codehaus.mojo.license.DownloadLicensesMojo

isSkip() - Method in class org.codehaus.mojo.license.LicenseListMojo

When is sets to true, will skip execution.

isSkip() - Method in class org.codehaus.mojo.license.RemoveFileHeaderMojo

isSkip() - Method in class org.codehaus.mojo.license.UpdateFileHeaderMojo

isSkip() - Method in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

When is sets to true, will skip execution.

isStable() - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo

isStringUrl(String) - Static method in class org.codehaus.mojo.license.utils.UrlRequester

Checks if the given input is a URL value.

isSuccess() - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

isTouched() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

isTouched() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

isTrimHeaderLine() - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Get flag if header line should be right trimmed when written.

isTrimHeaderLine() - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Get flag if header line should be right trimmed when written.

isValid(String) - Static method in class org.codehaus.mojo.license.LicenseMojoUtils

isVerbose() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

isVerbose() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

isVerbose() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

isVerbose() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Is log should be verbose?

isVerbose() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator

isVerbose() - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Is log should be verbose?

iterator() - Method in class org.codehaus.mojo.license.model.LicenseRepository

iterator() - Method in class org.codehaus.mojo.license.model.LicenseStore

J

JAR_LICENSE_REPOSITORY - Static variable in class org.codehaus.mojo.license.model.LicenseStore

class-path directory where is the licenses repository.

JavaFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for java format.

JavaFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Default constructor.

JspFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for jsp format.

JspFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.JspFileHeaderTransformer

Default constructor.

K

keys() - Method in class org.codehaus.mojo.license.utils.SortedProperties

L

lastYear - Variable in class org.codehaus.mojo.license.model.Copyright

Copyright last year of application (can be null if copyright is only on one year).

License - Class in org.codehaus.mojo.license.download

License(String, String, String, String) - Constructor for class org.codehaus.mojo.license.download.License

license(License) - Method in class org.codehaus.mojo.license.download.LicensedArtifact.Builder

license - Variable in class org.codehaus.mojo.license.header.FileHeader

License used in the header.

License - Class in org.codehaus.mojo.license.model

The model of a license.

License() - Constructor for class org.codehaus.mojo.license.model.License

license(SpdxLicenseInfo) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

LICENSE_CONTENT_FILE - Static variable in class org.codehaus.mojo.license.model.License

LICENSE_DB_TYPE - Static variable in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

LICENSE_DESCRIPTION_PATTERN - Static variable in class org.codehaus.mojo.license.model.LicenseRepository

LICENSE_HEADER_FILE - Static variable in class org.codehaus.mojo.license.model.License

LicenseContentSanitizer - Class in org.codehaus.mojo.license

LicenseContentSanitizer() - Constructor for class org.codehaus.mojo.license.LicenseContentSanitizer

LicensedArtifact - Class in org.codehaus.mojo.license.download

LicensedArtifact.Builder - Class in org.codehaus.mojo.license.download

A LicensedArtifact builder.

LicensedArtifactResolver - Class in org.codehaus.mojo.license.download

A tool to deal with dependencies of a project.

LicensedArtifactResolver() - Constructor for class org.codehaus.mojo.license.download.LicensedArtifactResolver

LicenseDownloader - Class in org.codehaus.mojo.license.download

Utilities for downloading remote license files.

LicenseDownloader(Proxy, int, int, int, Map<String, SpdxLicenseList.Attachments.ContentSanitizer>, Charset) - Constructor for class org.codehaus.mojo.license.download.LicenseDownloader

LicenseDownloader.LicenseDownloadResult - Class in org.codehaus.mojo.license.download

A result of a license download operation.

licenseFile - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

Project license file to synchronize with main license defined in descriptor file.

licenseId(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

LicenseListMojo - Class in org.codehaus.mojo.license

Display all available licenses.

LicenseListMojo() - Constructor for class org.codehaus.mojo.license.LicenseListMojo

licenseListVersion(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

licenseMap - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

LicenseMap - Class in org.codehaus.mojo.license.model

Map of artifacts (stub in mavenproject) group by their license.

LicenseMap() - Constructor for class org.codehaus.mojo.license.model.LicenseMap

Default contructor.

LicenseMap(Comparator<MavenProject>) - Constructor for class org.codehaus.mojo.license.model.LicenseMap

LicenseMatchers - Class in org.codehaus.mojo.license.download

A collection of DependencyMatchers to match and replace licenses in ProjectLicenseInfo instances.

LicenseMatchers.Builder - Class in org.codehaus.mojo.license.download

A LicenseMatchers builder

licenseMerges - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

To merge licenses in final file.

licenseMergesFile - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Deprecated.

prefer use now AbstractAddThirdPartyMojo.licenseMergesUrl

licenseMergesUrl - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Location of file with the merge licenses in order to be used by command line.

licenseMergesUrl - Variable in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo

Location of file with the merge licenses in order to be used by command line.

LicenseMojoUtils - Class in org.codehaus.mojo.license

Utility methods common to various mojos.

LicenseRepository - Class in org.codehaus.mojo.license.model

LicenseRepository() - Constructor for class org.codehaus.mojo.license.model.LicenseRepository

licenses - Variable in class org.codehaus.mojo.license.model.LicenseRepository

licenses of this repository.

licensesConfigFile - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

A file containing the license data (most notably license names and license URLs) missing in pom.xml files of the dependencies.

licensesInputFile - Variable in class org.codehaus.mojo.license.LicensesXmlInsertVersionsMojo

The file whose XML content will be used as a base for adding versions.

licensesOutputDirectory - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

The directory to which the dependency licenses should be written.

licensesOutputFile - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

The output file containing a mapping between each dependency and it's license information.

licensesOutputFileEol - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

An end of line constant name denoting the EOL string to use when redering the licenses.xml file.

LicenseStore - Class in org.codehaus.mojo.license.model

The LicenseStore offers License coming from different LicenseRepository.

LicenseStore() - Constructor for class org.codehaus.mojo.license.model.LicenseStore

LicenseSummaryReader - Class in org.codehaus.mojo.license.download

A LicenseSummaryReader.

LicenseSummaryReader() - Constructor for class org.codehaus.mojo.license.download.LicenseSummaryReader

LicenseSummaryWriter - Class in org.codehaus.mojo.license.download

A LicenseSummaryWriter.

LicenseSummaryWriter() - Constructor for class org.codehaus.mojo.license.download.LicenseSummaryWriter

LicensesXmlInsertVersionsMojo - Class in org.codehaus.mojo.license

Insert versions into a licenses.xml file that might have been generated by a *download-licenses mojo with writeVersions set to false.

LicensesXmlInsertVersionsMojo() - Constructor for class org.codehaus.mojo.license.LicensesXmlInsertVersionsMojo

licenseURL - Variable in class org.codehaus.mojo.license.model.License

url of the license's content.

licenseUrlFileNames - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

A map that helps to select local files names for the content downloaded from license URLs.

licenseUrlFileNameSanitizers - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

A list of regexp:replacement pairs that should be applied to file names for storing licenses.

LicenseUrlReplacement - Class in org.codehaus.mojo.license

Defines a license url pattern and replacement pair.

LicenseUrlReplacement() - Constructor for class org.codehaus.mojo.license.LicenseUrlReplacement

licenseUrlReplacements - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

List of regexps/replacements applied to the license urls prior to download.

LINE_SEPARATOR - Static variable in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Line separator.

load(File) - Static method in class org.codehaus.mojo.license.download.LicenseMatchers

load() - Method in class org.codehaus.mojo.license.model.LicenseRepository

load(File) - Method in class org.codehaus.mojo.license.utils.SortedProperties

Charge le properties a partir d'un fichier.

loadDependencies() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Loads the dependencies of the project (as MavenProject, indexed by their gav.

loadDependencies() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Loads the dependencies of the project (as MavenProject, indexed by their gav.

loadDependencies() - Method in class org.codehaus.mojo.license.AggregatorAddThirdPartyMojo

Loads the dependencies of the project (as MavenProject, indexed by their gav.

loadDependencies(MavenProjectDependenciesConfigurator, ResolvedProjectDependencies) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Load all dependencies given the configuration as MavenProject.

loadDependencies(MavenProjectDependenciesConfigurator, ResolvedProjectDependencies) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Load all dependencies given the configuration as MavenProject.

loadProjectArtifacts(ArtifactRepository, List<ArtifactRepository>, MavenProject, List<MavenProject>) - Method in class org.codehaus.mojo.license.api.DependenciesTool

Load project artifacts.

loadProjectDependencies(ResolvedProjectDependencies, MavenProjectDependenciesConfigurator, ArtifactRepository, List<ArtifactRepository>, SortedMap<String, MavenProject>) - Method in class org.codehaus.mojo.license.api.DependenciesTool

For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object.

loadProjectDependencies(ResolvedProjectDependencies, MavenProjectDependenciesConfigurator, ArtifactRepository, List<ArtifactRepository>, Map<String, LicensedArtifact>) - Method in class org.codehaus.mojo.license.download.LicensedArtifactResolver

For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object.

loadThirdPartyDescriptorForUnsafeMapping(Set<Artifact>, SortedSet<MavenProject>, Collection<MavenProject>, LicenseMap) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Try to load maximum of unsafe license mapping using third-party descriptors (from maven repositories) and return it.

loadThirdPartyDescriptorForUnsafeMapping(Set<Artifact>, SortedSet<MavenProject>, Collection<MavenProject>, LicenseMap) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Try to load maximum of unsafe license mapping using third-party descriptors (from maven repositories) and return it.

loadThirdPartyDescriptorsForUnsafeMapping(Set<Artifact>, String, Collection<MavenProject>, SortedSet<MavenProject>, LicenseMap, ArtifactRepository, List<ArtifactRepository>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Collect license information from property file, 'third-party' classified artifacts, and .license.properties dependencies.

loadThirdPartyDescriptorsForUnsafeMapping(Set<Artifact>, String, Collection<MavenProject>, SortedSet<MavenProject>, LicenseMap, ArtifactRepository, List<ArtifactRepository>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Collect license information from property file, 'third-party' classified artifacts, and .license.properties dependencies.

loadUnsafeMapping(LicenseMap, File, String, SortedMap<String, MavenProject>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Load unsafe mapping for all dependencies with no license in their pom, we will load the missing file if it exists and also add all dependencies from licenseMap with no license known.

loadUnsafeMapping(LicenseMap, SortedMap<String, MavenProject>, String, File, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Loads unsafe mapping and returns it.

loadUnsafeMapping(LicenseMap, File, String, SortedMap<String, MavenProject>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Load unsafe mapping for all dependencies with no license in their pom, we will load the missing file if it exists and also add all dependencies from licenseMap with no license known.

loadUnsafeMapping(LicenseMap, SortedMap<String, MavenProject>, String, File, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Loads unsafe mapping and returns it.

locale - Variable in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

The locale we are rendering for.

localRepository - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Local Repository.

localRepository - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

Location of the local repository.

localRepository - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

Location of the local repository.

log - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

maven logger.

M

matcher(LicenseMatchers.DependencyMatcher) - Method in class org.codehaus.mojo.license.download.LicenseMatchers.Builder

MavenProjectDependenciesConfigurator - Interface in org.codehaus.mojo.license.api

Contract to configure which dependencies will be loaded by the dependency tool via the method DependenciesTool#loadProjectDependencies(org.apache.maven.project.MavenProject, MavenProjectDependenciesConfigurator, org.apache.maven.artifact.repository.ArtifactRepository, List, java.util.SortedMap)

mergeLicenses(List<String>, LicenseMap) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper

Merges licenses.

mergeLicenses(LicenseMap, String, Set<String>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

For a given licenseMap, merge all licenses.

mergeLicenses(List<String>, LicenseMap) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper

Merges licenses.

mergeLicenses(LicenseMap, String, Set<String>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

For a given licenseMap, merge all licenses.

missingFile - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

The file to write with a license information template for dependencies with unknown license.

missingFileUrl - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

The Url that holds the missing license dependency entries.

missingLicensesFileArtifact - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

To resolve third party licenses from an artifact.

modified - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

flag set to true when a header was detected and was modified.

MojoHelper - Class in org.codehaus.mojo.license.utils

Mojo helper methods.

MojoHelper() - Constructor for class org.codehaus.mojo.license.utils.MojoHelper

MySqlFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for mysql format.

MySqlFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.MySqlFileHeaderTransformer

Default constructor.

N

name - Variable in class org.codehaus.mojo.license.model.License

the name of the licenses (ex lgpl-3.0).

name(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

newCopyright(Integer, Integer, String) - Static method in class org.codehaus.mojo.license.model.Copyright

newCopyright(Integer, String) - Static method in class org.codehaus.mojo.license.model.Copyright

newDefaultHelper() - Static method in class org.codehaus.mojo.license.api.FreeMarkerHelper

newHelperFromContent(String) - Static method in class org.codehaus.mojo.license.api.FreeMarkerHelper

newMavenProjectComparator() - Static method in class org.codehaus.mojo.license.utils.MojoHelper

newMavenProjectComparatorByName() - Static method in class org.codehaus.mojo.license.utils.MojoHelper

O

of(String, String, String, String, String, String, String, String, boolean, String, String) - Static method in class org.codehaus.mojo.license.api.ArtifactFilters

orderFiles(Collection<File>) - Static method in class org.codehaus.mojo.license.utils.FileUtil

org.codehaus.mojo.license - package org.codehaus.mojo.license

org.codehaus.mojo.license.api - package org.codehaus.mojo.license.api

Api package

org.codehaus.mojo.license.download - package org.codehaus.mojo.license.download

org.codehaus.mojo.license.header - package org.codehaus.mojo.license.header

Header package

org.codehaus.mojo.license.header.transformer - package org.codehaus.mojo.license.header.transformer

Header transformer package

org.codehaus.mojo.license.model - package org.codehaus.mojo.license.model

Model package

org.codehaus.mojo.license.spdx - package org.codehaus.mojo.license.spdx

org.codehaus.mojo.license.utils - package org.codehaus.mojo.license.utils

organizationName - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

Name of project's organization.

organizeLicensesByDependencies - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

A flag to organize the licenses by dependencies.

outputDirectory - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Directory where to generate files.

outputDirectory - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

The directory where to generate license resources.

overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Override licenses from override file.

overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Override licenses from override file.

P

parseLicenseSummary(File) - Static method in class org.codehaus.mojo.license.download.LicenseSummaryReader

parseLicenseSummary(InputStream) - Static method in class org.codehaus.mojo.license.download.LicenseSummaryReader

Read a component-info.xml from an input stream into a ComponentInfo object.

performInFilter(String) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

performOutFilter(String) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

PhpFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for PHP format.

PhpFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.PhpFileHeaderTransformer

Default constructor.

PreferredFileNames - Class in org.codehaus.mojo.license.download

An url -> FileNameEntry mapping.

PreferredFileNames(File, Map<String, Map.Entry<String, List<Pattern>>>, Map<String, String>, Log) - Constructor for class org.codehaus.mojo.license.download.PreferredFileNames

printString(File, String, String) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Print content to file.

process(String, File, String) - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

processLicenseContext(String) - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo

processTagHeaderContent - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

cached full header content (with process tag + comment box).

project - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

The Maven Project Object

project - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

The Maven Project Object

projectDependencies - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

ProjectLicense - Class in org.codehaus.mojo.license.download

The license subelement of ProjectLicenseInfo.

ProjectLicense() - Constructor for class org.codehaus.mojo.license.download.ProjectLicense

The default constructor.

ProjectLicense(License) - Constructor for class org.codehaus.mojo.license.download.ProjectLicense

Equivalent to new ProjectLicense( license.getName(), license.getUrl(), license.getDistribution(), license.getComments(), null )

ProjectLicense(String, String, String, String, String) - Constructor for class org.codehaus.mojo.license.download.ProjectLicense

The full constructor.

ProjectLicenseInfo - Class in org.codehaus.mojo.license.download

Contains the license information for a single project/dependency

ProjectLicenseInfo() - Constructor for class org.codehaus.mojo.license.download.ProjectLicenseInfo

Default constructor.

ProjectLicenseInfo(String, String, String) - Constructor for class org.codehaus.mojo.license.download.ProjectLicenseInfo

ProjectLicenseInfo(String, String, String, boolean) - Constructor for class org.codehaus.mojo.license.download.ProjectLicenseInfo

projectName - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo

Name of project (or module).

PropertiesFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for properties format.

PropertiesFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.PropertiesFileHeaderTransformer

Default constructor.

put(String, LicenseDownloader.LicenseDownloadResult) - Method in class org.codehaus.mojo.license.download.Cache

Binds the given url to the give LicenseDownloader.LicenseDownloadResult.

put(String, MavenProject) - Method in class org.codehaus.mojo.license.model.LicenseMap

Store in the license map a project to a given license.

putAll(LicenseMap) - Method in class org.codehaus.mojo.license.model.LicenseMap

Store in the license other licenseMap.

R

readAsString(File, String) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Permet de lire un fichier et de retourner sont contenu sous forme d'une chaine de carateres.

reference(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

rejectPackaging(String...) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Accept the project's packaging if not in given one.

releaseDate(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

remoteRepositories - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Remote repositories used for the project.

remoteRepositories - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

List of Remote Repositories used by the resolver

remoteRepositories - Variable in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

List of Remote Repositories used by the resolver

RemoveFileHeaderMojo - Class in org.codehaus.mojo.license

The goal to remove the header on project source files.

RemoveFileHeaderMojo() - Constructor for class org.codehaus.mojo.license.RemoveFileHeaderMojo

removeHeader - Variable in class org.codehaus.mojo.license.utils.SortedProperties

un drapeau pour savoir s'il faut enlever l'entete generere

removeProject(MavenProject) - Method in class org.codehaus.mojo.license.model.LicenseMap

renameFile(File, File) - Static method in class org.codehaus.mojo.license.utils.FileUtil

Rename the given file to a new destination.

renderBody() - Method in class org.codehaus.mojo.license.ThirdPartyReportRenderer

renderErrorIcon() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderInfoIcon() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderPropertySummaryTableHeader() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderSuccessIcon() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderTemplate(String, Map<String, Object>) - Method in class org.codehaus.mojo.license.api.FreeMarkerHelper

renderTemplate(Template, Map<String, Object>) - Method in class org.codehaus.mojo.license.api.FreeMarkerHelper

renderThirdPartyDetailTable(ThirdPartyDetails) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartyDetailTable(ThirdPartyDetails, boolean, boolean, boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTable(Collection<ThirdPartyDetails>) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTable(Collection<ThirdPartyDetails>, boolean, boolean, boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTableHeader() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTableHeader(boolean, boolean, boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTableRow(ThirdPartyDetails) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderThirdPartySummaryTableRow(ThirdPartyDetails, boolean, boolean, boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

renderWarningIcon() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

replaceMatches(ProjectLicenseInfo) - Method in class org.codehaus.mojo.license.download.LicenseMatchers

Replace matching licenses in the given dependency

replacement(String, String, String) - Method in class org.codehaus.mojo.license.download.UrlReplacements.Builder

repositories - Variable in class org.codehaus.mojo.license.model.LicenseStore

list of available license repositories.

REPOSITORY_DEFINITION_FILE - Static variable in class org.codehaus.mojo.license.model.LicenseRepository

reset() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

resetContent() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

resolveDependencyArtifacts() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo

Resolves the transitive and direct dependency sets for this project.

resolvedOverrideUrl - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A URL prepared either our of AbstractAddThirdPartyMojo.overrideFile or AbstractAddThirdPartyMojo.overrideUrl or the default value.

ResolvedProjectDependencies - Class in org.codehaus.mojo.license.api

Copies of the project's dependency sets.

ResolvedProjectDependencies(Set<Artifact>, Set<Artifact>) - Constructor for class org.codehaus.mojo.license.api.ResolvedProjectDependencies

resolveMissingLicensesDescriptor(String, String, String, ArtifactRepository, List<ArtifactRepository>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

resolveMissingLicensesDescriptor(String, String, String, ArtifactRepository, List<ArtifactRepository>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

resolvThirdPartyDescriptor(MavenProject, ArtifactRepository, List<ArtifactRepository>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Obtain the third party file from the repository.

resolvThirdPartyDescriptor(MavenProject, ArtifactRepository, List<ArtifactRepository>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Obtain the third party file from the repository.

rewriteIfNecessary(String) - Method in class org.codehaus.mojo.license.download.UrlReplacements

ROLE - Static variable in interface org.codehaus.mojo.license.api.ThirdPartyTool

Plexus Role.

RootPackageClassPathLicenseRepository - Class in org.codehaus.mojo.license.model

A special class-path license repository defined on root java package.

RootPackageClassPathLicenseRepository() - Constructor for class org.codehaus.mojo.license.model.RootPackageClassPathLicenseRepository

RstFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for apt format.

RstFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.RstFileHeaderTransformer

Default constructor.

S

safeBold() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

safeBold_() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

safeItalic() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

safeItalic_() - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

sanitize(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer

script(String, String) - Method in class org.codehaus.mojo.license.api.ArtifactFilters.Builder

seeAlso(String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

setAddJavaLicenseAfterPackage(boolean) - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Sets the value to the property JavaFileHeaderTransformer.addJavaLicenseAfterPackage.

setApproved(boolean) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setArtifactId(String) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setBaseURL(URL) - Method in class org.codehaus.mojo.license.model.License

setBaseURL(URL) - Method in class org.codehaus.mojo.license.model.LicenseRepository

setCommentEndTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the comment end tag.

setCommentEndTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the comment end tag.

setCommentLinePrefix(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the comment prefix line.

setCommentLinePrefix(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the comment prefix line.

setComments(String) - Method in class org.codehaus.mojo.license.download.ProjectLicense

Set addendum information pertaining to this license.

setCommentStartTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the comment start tag.

setCommentStartTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the comment start tag.

setCopyright(Copyright) - Method in class org.codehaus.mojo.license.header.FileHeader

setDescription(String) - Method in class org.codehaus.mojo.license.header.FileHeader

setDescription(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Chages the description of the transformer.

setDescription(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Chages the description of the transformer.

setDescription(String) - Method in class org.codehaus.mojo.license.model.License

setDistribution(String) - Method in class org.codehaus.mojo.license.download.ProjectLicense

Set the primary method by which this project may be distributed.

setEmptyLineAfterHeader(boolean) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Set flag if there should be an empty line after the header.

setEmptyLineAfterHeader(boolean) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Set flag if there should be an empty line after the header.

setEncoding(String) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Sets new encoding used to read and write files.

setExcludedLicense(String) - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.ExcludedLicenses

Add a simple exclude License to the list.

setExcludedLicenses(String) - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Fill the AbstractAddThirdPartyMojo.excludedLicenses parameter from a simple string to split.

setFile(String) - Method in class org.codehaus.mojo.license.download.ProjectLicense

Set the name of the license file (without path) downloaded from ProjectLicense.url.

setFileHeader(FileHeader) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

setGroupId(String) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setHasMatchLicenses(boolean) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setHeaderURL(URL) - Method in class org.codehaus.mojo.license.model.License

setIncludedLicense(String) - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedLicenses

Add a simple a include license to the list.

setIncludedLicenses(String) - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Fill the AbstractAddThirdPartyMojo.includedLicenses parameter from a simple string to split.

setLicense(String) - Method in class org.codehaus.mojo.license.header.FileHeader

setLicenses(List<ProjectLicense>) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setLicenseURL(URL) - Method in class org.codehaus.mojo.license.model.License

setLineSeparator(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

setLineSeparator(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

setLog(Log) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

Sets the logger.

setMatchLicenses(List<ProjectLicense>) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

setName(String) - Method in class org.codehaus.mojo.license.download.ProjectLicense

Set the full legal name of the license.

setName(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the name of the transformer.

setName(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the name of the transformer.

setName(String) - Method in class org.codehaus.mojo.license.model.License

setPomLicenses(String[]) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

Sets the pom licenses.

setPomLicenses(String[]) - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

Sets the pom licenses.

setProcessEndTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the process end tag.

setProcessEndTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the process end tag.

setProcessStartTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Changes the process start tag.

setProcessStartTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Changes the process start tag.

setSectionDelimiter(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Sets the header section delimiter.

setSectionDelimiter(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Sets the header section delimiter.

setThirdPartyLicenses(String[]) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails

Sets the third-party licenses.

setThirdPartyLicenses(String[]) - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails

Sets the third-party licenses.

setTransformer(FileHeaderTransformer) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter

setTrimHeaderLine(boolean) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Set flag if header line should be right trimmed when written.

setTrimHeaderLine(boolean) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Set flag if header line should be right trimmed when written.

setUpdateCopyright(boolean) - Method in class org.codehaus.mojo.license.header.UpdateFileHeaderFilter

setUpdateDescription(boolean) - Method in class org.codehaus.mojo.license.header.UpdateFileHeaderFilter

setUpdateLicense(boolean) - Method in class org.codehaus.mojo.license.header.UpdateFileHeaderFilter

setUrl(String) - Method in class org.codehaus.mojo.license.download.ProjectLicense

Set the official url for the license text.

setUseNoReformatCommentStartTag(boolean) - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Sets the value of the property JavaFileHeaderTransformer.useNoReformatCommentStartTag.

setVerbose(boolean) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo

Sets new value to AbstractLicenseMojo.verbose flag.

setVerbose(boolean) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Sets the verbose mode.

setVerbose(boolean) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Sets the verbose mode.

setVersion(String) - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

sha1(Path) - Static method in class org.codehaus.mojo.license.utils.FileUtil

sinkCellText(String, String) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

sinkCellText(String) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

sinkHeaderCellText(String) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

sinkHeaderCellText(String, String) - Method in class org.codehaus.mojo.license.AbstractLicenseReportRenderer

skipDownloadLicenses - Variable in class org.codehaus.mojo.license.DownloadLicensesMojo

A flag to skip the goal.

skipUpdateProjectLicense - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo

A flag to skip the goal.

sortArtifactByName - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A flag to sort artifact by name in the generated third-party file.

SortedProperties - Class in org.codehaus.mojo.license.utils

Permet d'avoir les fichiers de proprietes tries.

SortedProperties(String) - Constructor for class org.codehaus.mojo.license.utils.SortedProperties

SortedProperties(String, boolean) - Constructor for class org.codehaus.mojo.license.utils.SortedProperties

SortedProperties(Properties) - Constructor for class org.codehaus.mojo.license.utils.SortedProperties

SpdxLicenseInfo - Class in org.codehaus.mojo.license.spdx

A license item from SPDX licenses.json.

SpdxLicenseInfo(String, boolean, boolean, String, String, String, List<String>, boolean, SpdxLicenseInfo.Attachments) - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseInfo

SpdxLicenseInfo.Attachments - Class in org.codehaus.mojo.license.spdx

Data not coming directly from SPDX licenses.json but enhanced by us.

SpdxLicenseInfo.Attachments.UrlInfo - Class in org.codehaus.mojo.license.spdx

A sha1 checksum and mime type associated with an URL.

SpdxLicenseInfo.Builder - Class in org.codehaus.mojo.license.spdx

A SpdxLicenseInfo builder.

SpdxLicenseList - Class in org.codehaus.mojo.license.spdx

A Java representation of SPDX licenses.json

SpdxLicenseList.Attachments - Class in org.codehaus.mojo.license.spdx

SpdxLicenseList.Attachments.ContentSanitizer - Class in org.codehaus.mojo.license.spdx

SpdxLicenseList.Attachments.UrlReplacement - Class in org.codehaus.mojo.license.spdx

SpdxLicenseList.Builder - Class in org.codehaus.mojo.license.spdx

A SpdxLicenseList builder.

SqlFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for sql format.

SqlFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.SqlFileHeaderTransformer

Default constructor.

store(File) - Method in class org.codehaus.mojo.license.utils.SortedProperties

Sauvegarde le properties dans un fichier, sans commentaire et en utilisant l'encoding declare.

StringToList - Class in org.codehaus.mojo.license.utils

Object to convert in mojo a parameter from a some simple String to a List.

StringToList() - Constructor for class org.codehaus.mojo.license.utils.StringToList

StringToList(String) - Constructor for class org.codehaus.mojo.license.utils.StringToList

success(File, String, boolean) - Static method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

T

TEMPLATE - Static variable in class org.codehaus.mojo.license.api.FreeMarkerHelper

TEMPLATE_SUFFIX - Static variable in class org.codehaus.mojo.license.model.License

templateLoader - Variable in class org.codehaus.mojo.license.api.FreeMarkerHelper

ThirdPartyDetails - Interface in org.codehaus.mojo.license.api

Details of a artifact about his third-parties stuff.

thirdPartyFilename - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

File where to write the third-party file.

ThirdPartyHelper - Interface in org.codehaus.mojo.license.api

Helper class that provides common functionality required by both the mojos and the reports.

ThirdPartyReportMojo - Class in org.codehaus.mojo.license

Generates a report of all third-parties detected in the module.

ThirdPartyReportMojo() - Constructor for class org.codehaus.mojo.license.ThirdPartyReportMojo

ThirdPartyReportRenderer - Class in org.codehaus.mojo.license

Generates a report of third parties of the project.

ThirdPartyReportRenderer(Sink, I18N, String, Locale, Collection<ThirdPartyDetails>) - Constructor for class org.codehaus.mojo.license.ThirdPartyReportRenderer

ThirdPartyTool - Interface in org.codehaus.mojo.license.api

A tool to load third party files missing files.

ThirdPartyToolException - Exception in org.codehaus.mojo.license.api

An exception occurring during the execution of this tool.

ThirdPartyToolException(String, Exception) - Constructor for exception org.codehaus.mojo.license.api.ThirdPartyToolException

Construct a new ThirdPartyToolException exception wrapping an underlying Exception and providing a message.

ThirdPartyToolException(String, Throwable) - Constructor for exception org.codehaus.mojo.license.api.ThirdPartyToolException

Construct a new ThirdPartyToolException exception wrapping an underlying Throwable and providing a message.

ThirdPartyToolException(String) - Constructor for exception org.codehaus.mojo.license.api.ThirdPartyToolException

Construct a new ThirdPartyToolException exception providing a message.

TIME_FACTORS - Static variable in class org.codehaus.mojo.license.utils.MojoHelper

TIME_UNITES - Static variable in class org.codehaus.mojo.license.utils.MojoHelper

toDependencyMap() - Method in class org.codehaus.mojo.license.model.LicenseMap

Build a dependencies map from the license map, this is a map of license for each project registered in the license map.

toExtension(String, boolean) - Static method in class org.codehaus.mojo.license.utils.FileUtil

toFileHeader(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Build a FileHeader from an UNBOXED header content.

toFileHeader(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Build a FileHeader from an UNBOXED header content.

toGavString() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

toGenericList(List<?>, Class<O>) - Static method in class org.codehaus.mojo.license.utils.SortedProperties

Permet de convertir une liste non typee, en une liste typee.

toHeaderContent(FileHeader) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Build a fully boxed header content from the given model.

toHeaderContent(FileHeader) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Build a fully boxed header content from the given model.

toLicenseMapOrderByName() - Method in class org.codehaus.mojo.license.model.LicenseMap

toString() - Method in class org.codehaus.mojo.license.download.ProjectLicenseInfo

toString(FileHeader) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Build a UNBOXED header content from the given model.

toString(FileHeader) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Build a UNBOXED header content from the given model.

toString() - Method in class org.codehaus.mojo.license.model.Copyright

toString() - Method in class org.codehaus.mojo.license.model.License

touched - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

flag set to true when a header was detected (says detects both start and end process tags).

transformer - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter

header transformer.

tryClose(InputStream) - Static method in class org.codehaus.mojo.license.utils.FileUtil

tryClose(OutputStream) - Static method in class org.codehaus.mojo.license.utils.FileUtil

U

unboxComent(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Unbox the given boxed boxedHeader to obtain the header content.

unboxComent(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Unbox the given boxed boxedHeader to obtain the header content.

unboxProcessTag(String) - Method in class org.codehaus.mojo.license.header.transformer.AbstractFileHeaderTransformer

Unbox the process tag on the given boxed boxedHeader to obtain the brute header content.

unboxProcessTag(String) - Method in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer

Unbox the process tag on the given boxed boxedHeader to obtain the brute header content.

UNKNOWN_LICENSE_MESSAGE - Static variable in class org.codehaus.mojo.license.model.LicenseMap

unsafeDependencies - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

unsafeMappings - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

updateDescription(String) - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor

UpdateFileHeaderFilter - Class in org.codehaus.mojo.license.header

Implementation of FileHeaderFilter to update an incoming header.

UpdateFileHeaderFilter() - Constructor for class org.codehaus.mojo.license.header.UpdateFileHeaderFilter

UpdateFileHeaderMojo - Class in org.codehaus.mojo.license

The goal to update (or add) the header on project source files.

UpdateFileHeaderMojo() - Constructor for class org.codehaus.mojo.license.UpdateFileHeaderMojo

UpdateProjectLicenseMojo - Class in org.codehaus.mojo.license

Updates (or creates) the main project license file according to the given license defines as AbstractLicenseNameMojo.licenseName.

UpdateProjectLicenseMojo() - Constructor for class org.codehaus.mojo.license.UpdateProjectLicenseMojo

UrlInfo(String, String, boolean, boolean) - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo

urlInfo(String, String, String, boolean, boolean) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Builder

UrlReplacement(String, Pattern, String) - Constructor for class org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement

urlReplacement(String, String, String) - Method in class org.codehaus.mojo.license.spdx.SpdxLicenseList.Builder

UrlReplacements - Class in org.codehaus.mojo.license.download

Applies manually configured license URL replacements as well as the default ones a necessary.

UrlReplacements.Builder - Class in org.codehaus.mojo.license.download

A UrlReplacements builder.

UrlRequester - Class in org.codehaus.mojo.license.utils

This class should be used to load the content from a URL.

UrlRequester() - Constructor for class org.codehaus.mojo.license.utils.UrlRequester

useDefaults(boolean) - Method in class org.codehaus.mojo.license.download.UrlReplacements.Builder

useDefaultUrlReplacements - Variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo

If true the default license URL replacements be added to the internal Map of URL replacements before adding AbstractDownloadLicensesMojo.licenseUrlReplacements by their id; otherwise the default license URL replacements will not be added to the internal Map of URL replacements.

useMissingFile - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

A flag to use the missing licenses file to consolidate the THID-PARTY file.

useNoReformatCommentStartTag - Variable in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer

Flag to use comment start tag with a no reformat syntax /*-.

useRepositoryMissingFiles - Variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo

Load files supplying information for missing third party licenses from repositories.

V

valueOf(String) - Static method in enum org.codehaus.mojo.license.AbstractDownloadLicensesMojo.ErrorRemedy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codehaus.mojo.license.Eol

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codehaus.mojo.license.FileState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.codehaus.mojo.license.AbstractDownloadLicensesMojo.ErrorRemedy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codehaus.mojo.license.Eol

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codehaus.mojo.license.FileState

Returns an array containing the constants of this enum type, in the order they are declared.

W

withFile(File) - Method in class org.codehaus.mojo.license.download.LicenseDownloader.LicenseDownloadResult

writeBundleThirdPartyFile(File, File, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Writes the bundled version of the third-party file.

writeBundleThirdPartyFile(File, File, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Writes the bundled version of the third-party file.

writeLicenseSummary(List<ProjectLicenseInfo>, File, boolean) - Method in class org.codehaus.mojo.license.AbstractLicensesXmlMojo

writeLicenseSummary(List<ProjectLicenseInfo>, File, Charset, Eol, boolean) - Static method in class org.codehaus.mojo.license.download.LicenseSummaryWriter

writeThirdPartyFile(LicenseMap, File, boolean, String, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool

Write the content of the third-party file.

writeThirdPartyFile(LicenseMap, File, boolean, String, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool

Write the content of the third-party file.

X

XmlFileHeaderTransformer - Class in org.codehaus.mojo.license.header.transformer

Implementation of FileHeaderTransformer for xml format.

XmlFileHeaderTransformer() - Constructor for class org.codehaus.mojo.license.header.transformer.XmlFileHeaderTransformer

Default constructor.

A B C D E F G H I J K L M N O P R S T U V W X