Skip navigation links
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.HiddenLicenses - Class in org.codehaus.mojo.license
Class to fill the AbstractAddThirdPartyMojo.hiddenLicenses parameter, from a simple string to split, or a list of string.
AbstractAddThirdPartyMojo.IncludedDependencies - Class in org.codehaus.mojo.license
 
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
 
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
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
 
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.
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(License) - Method in class org.codehaus.mojo.license.model.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
 
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.
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.

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.
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.

C

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.
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
 
ComponentInfo - Class in org.codehaus.mojo.license.nexus
Created on 30.01.2018.
ComponentInfo() - Constructor for class org.codehaus.mojo.license.nexus.ComponentInfo
 
ComponentInfo.License - Class in org.codehaus.mojo.license.nexus
 
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) - Static method in class org.codehaus.mojo.license.utils.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>, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper
Creates a license map from given dependencies.
createLicenseMap(Collection<MavenProject>, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper
 
createLicenseMap(SortedMap<String, MavenProject>, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper
Creates a license map from given dependencies.
createLicenseMap(Collection<MavenProject>, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper
 
createLicenseNode(Document, License) - Static method in class org.codehaus.mojo.license.utils.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, boolean, SortedSet<MavenProject>, SortedMap<String, MavenProject>) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper
Loads unsafe mappings.
createUnsafeMapping(LicenseMap, File, boolean, SortedSet<MavenProject>, SortedMap<String, MavenProject>) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper
Loads unsafe mappings.

D

DEFAULT_CONNECTION_TIMEOUT - Static variable in class org.codehaus.mojo.license.utils.LicenseDownloader
Defines the connection timeout in milliseconds when attempting to download license files.
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.
DefaultDependenciesTool - Class in org.codehaus.mojo.license.api
Default implementation of the DependenciesTool.
DefaultDependenciesTool() - Constructor for class org.codehaus.mojo.license.api.DefaultDependenciesTool
 
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.
DEP_SEPARATOR - Static variable in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo
 
DependenciesTool - Interface in org.codehaus.mojo.license.api
A tool to deal with dependencies of a project.
DependenciesToolException - Exception in org.codehaus.mojo.license.api
Created on 23/05/16.
DependenciesToolException(Throwable) - Constructor for exception org.codehaus.mojo.license.api.DependenciesToolException
 
Dependency - Class in org.codehaus.mojo.license.model
 
Dependency() - Constructor for class org.codehaus.mojo.license.model.Dependency
 
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.
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.
downloadFromGitLab(String, File) - Method in class org.codehaus.mojo.license.utils.LicenseDownloader
 
downloadLicense(String, String, File) - Method in class org.codehaus.mojo.license.utils.LicenseDownloader
 
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
 

E

encoding - Variable in class org.codehaus.mojo.license.utils.SortedProperties
l'encoding a utiliser pour lire et ecrire le properties.
equals(Object) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails
equals(Object) - Method in class org.codehaus.mojo.license.model.Copyright
 
equals(Object) - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
ExcludedLicenses() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.ExcludedLicenses
Default constructor used when AbstractAddThirdPartyMojo.excludedLicenses parameter is configured by a list.
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.JarsJsonListMojo
 
executeReport(Locale) - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
extraTemplateParameters - Variable in class org.codehaus.mojo.license.AbstractLicenseNameMojo
optional extra templates parameters.

F

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).
FileState - Enum in org.codehaus.mojo.license
Defines state of a file after process.
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.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.UpdateProjectLicenseMojo
A flag to copy the main license file in a bundled place.
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.
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.model.Dependency
 
getArtifactId() - Method in class org.codehaus.mojo.license.model.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
 
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
 
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
 
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
 
getDeclaredLicenses() - Method in class org.codehaus.mojo.license.nexus.ComponentInfo
 
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(MavenProject) - 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.Dependency
 
getDescription() - Method in class org.codehaus.mojo.license.model.License
 
getEncoding() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
 
getEncoding() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo
 
getExcludedArtifacts() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getExcludedArtifacts() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getExcludedArtifacts() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getExcludedArtifacts() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getExcludedGroups() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getExcludedGroups() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getExcludedGroups() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getExcludedGroups() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getExcludedScopes() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getExcludedScopes() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getExcludedScopes() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getExcludedScopes() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getFile(File, String...) - Static method in class org.codehaus.mojo.license.utils.FileUtil
 
getFileContent(String) - Method in class org.codehaus.mojo.license.utils.LicenseRegistryClient
 
getFileHeader() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter
 
getFileHeaderDescription() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor
 
getFileNameOffVersion() - Method in class org.codehaus.mojo.license.model.Dependency
 
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
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.model.Dependency
 
getGroupId() - Method in class org.codehaus.mojo.license.model.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.model.ProjectLicenseInfo
The unique ID for the project
getIncludedArtifacts() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getIncludedArtifacts() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getIncludedArtifacts() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getIncludedArtifacts() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getIncludedGroups() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getIncludedGroups() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getIncludedGroups() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getIncludedGroups() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getIncludedScopes() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
getIncludedScopes() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getIncludedScopes() - Method in class org.codehaus.mojo.license.AddThirdPartyMojo
getIncludedScopes() - Method in interface org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator
 
getInstance() - Static method in class org.codehaus.mojo.license.utils.LicenseRegistryClient
 
getLastYear() - Method in class org.codehaus.mojo.license.model.Copyright
 
getLicencesByProject(MavenProject) - Method in class org.codehaus.mojo.license.nexus.LicenseProcessor
 
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.nexus.ComponentInfo.License
 
getLicenseLink() - Method in class org.codehaus.mojo.license.model.Dependency
 
getLicenseMap() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo
 
getLicenseName() - Method in class org.codehaus.mojo.license.AbstractLicenseNameMojo
 
getLicenseName() - Method in class org.codehaus.mojo.license.nexus.ComponentInfo.License
 
getLicenseNames() - Method in class org.codehaus.mojo.license.model.LicenseRepository
 
getLicenseNames() - Method in class org.codehaus.mojo.license.model.LicenseStore
 
getLicenseResolutionResult() - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
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.model.LicenseRepository
 
getLicenses() - Method in class org.codehaus.mojo.license.model.LicenseStore
 
getLicenses() - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
getLicenseType() - Method in class org.codehaus.mojo.license.model.Dependency
 
getLicenseURL() - Method in class org.codehaus.mojo.license.model.License
 
getLog() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter
 
getLog() - Method in class org.codehaus.mojo.license.nexus.LicenseProcessor
 
getModification() - Method in class org.codehaus.mojo.license.model.Dependency
 
getName(Locale) - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
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.Dependency
 
getName() - Method in class org.codehaus.mojo.license.model.License
 
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
 
getObservedLicenses() - Method in class org.codehaus.mojo.license.nexus.ComponentInfo
 
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
 
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.
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.
getSession() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo
 
getSiteRenderer() - Method in class org.codehaus.mojo.license.AbstractThirdPartyReportMojo
getSystem() - Method in class org.codehaus.mojo.license.model.Dependency
 
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(URL, String) - Static method in class org.codehaus.mojo.license.utils.MojoHelper
suffix a given baseUrl with the given suffix
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.model.Dependency
 
getVersion() - Method in class org.codehaus.mojo.license.model.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.model.Copyright
 
hashCode() - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
hasLicenses() - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyDetails
hasLicenses() - Method in interface org.codehaus.mojo.license.api.ThirdPartyDetails
 
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.
HiddenLicenses() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.HiddenLicenses
Default constructor used when AbstractAddThirdPartyMojo.hiddenLicenses parameter is configured by a list.
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.
IncludedDependencies() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedDependencies
 
IncludedDependencies(String) - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedDependencies
 
IncludedDependencies(Collection<String>) - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedDependencies
 
IncludedLicenses() - Constructor for class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.IncludedLicenses
Default constructor used when AbstractAddThirdPartyMojo.includedLicenses parameter is configured by a list.
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.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.DefaultDependenciesTool
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.
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.
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.
isExcludable(Artifact, Pattern, Pattern) - Method in class org.codehaus.mojo.license.api.DefaultDependenciesTool
Tests if the given project is excludable against a groupdId pattern and a artifact pattern.
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
 
isFailIfWarning() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo
 
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
 
isHeaderContentTemplateAware() - Method in class org.codehaus.mojo.license.model.License
 
isIncludable(Artifact, Pattern, Pattern) - Method in class org.codehaus.mojo.license.api.DefaultDependenciesTool
Tests if the given project is includeable against a groupdId pattern and a artifact pattern.
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
 
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.
isSkipAll() - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
 
isSkipAll() - Method in class org.codehaus.mojo.license.AbstractLicenseMojo
When is sets to true, will skip execution.
isTouched() - Method in class org.codehaus.mojo.license.header.FileHeaderFilter
 
isTouched() - Method in class org.codehaus.mojo.license.header.FileHeaderProcessor
 
isUseMissingFile() - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo
 
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.
JarsJsonListMojo - Class in org.codehaus.mojo.license
Generates JSON file with list of dependencies from jars folder.
JarsJsonListMojo() - Constructor for class org.codehaus.mojo.license.JarsJsonListMojo
 
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 - 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() - Constructor for class org.codehaus.mojo.license.nexus.ComponentInfo.License
 
LICENSE_CONTENT_FILE - Static variable in class org.codehaus.mojo.license.model.License
 
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
 
LICENSE_MAP_KEY - Static variable in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
 
LicenseDownloader - Class in org.codehaus.mojo.license.utils
Utilities for downloading remote license files.
LicenseDownloader(String) - Constructor for class org.codehaus.mojo.license.utils.LicenseDownloader
 
licenseFile - Variable in class org.codehaus.mojo.license.UpdateProjectLicenseMojo
Project license file to synchronize with main license defined in descriptor file.
LicenseListMojo - Class in org.codehaus.mojo.license
Display all available licenses.
LicenseListMojo() - Constructor for class org.codehaus.mojo.license.LicenseListMojo
 
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.
LicenseProcessor - Class in org.codehaus.mojo.license.nexus
Created on 31.01.2018.
LicenseProcessor(Log, String) - Constructor for class org.codehaus.mojo.license.nexus.LicenseProcessor
 
LicenseRegistryClient - Class in org.codehaus.mojo.license.utils
 
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.
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.utils
A LicenseSummaryReader.
LicenseSummaryReader() - Constructor for class org.codehaus.mojo.license.utils.LicenseSummaryReader
 
LicenseSummaryWriter - Class in org.codehaus.mojo.license.utils
A LicenseSummaryWriter.
LicenseSummaryWriter() - Constructor for class org.codehaus.mojo.license.utils.LicenseSummaryWriter
 
licenseURL - Variable in class org.codehaus.mojo.license.model.License
url of the license's content.
LINE_SEPARATOR - Static variable in interface org.codehaus.mojo.license.header.transformer.FileHeaderTransformer
Line separator.
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) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyHelper
Load all dependencies given the configuration as MavenProject.
loadDependencies(MavenProjectDependenciesConfigurator) - Method in interface org.codehaus.mojo.license.api.ThirdPartyHelper
Load all dependencies given the configuration as MavenProject.
loadProjectArtifacts(ArtifactRepository, List, MavenProject, Map<String, List<Dependency>>) - Method in class org.codehaus.mojo.license.api.DefaultDependenciesTool
Load project artifacts.
loadProjectArtifacts(ArtifactRepository, List, MavenProject, Map<String, List<Dependency>>) - Method in interface org.codehaus.mojo.license.api.DependenciesTool
Load project artifacts.
loadProjectDependencies(MavenProject, MavenProjectDependenciesConfigurator, ArtifactRepository, List<ArtifactRepository>, SortedMap<String, MavenProject>) - Method in class org.codehaus.mojo.license.api.DefaultDependenciesTool
For a given project, obtain the universe of its dependencies after applying transitivity and filtering rules given in the configuration object.
loadProjectDependencies(MavenProject, MavenProjectDependenciesConfigurator, ArtifactRepository, List<ArtifactRepository>, SortedMap<String, MavenProject>) - Method in interface 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.
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, 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) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool
Loads unsafe mapping and returns it.
loadUnsafeMapping(LicenseMap, File, 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) - 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.
log - Variable in class org.codehaus.mojo.license.header.FileHeaderFilter
maven logger.

M

MAPPER - Static variable in class org.codehaus.mojo.license.api.DefaultDependenciesTool
 
MavenProjectDependenciesConfigurator - Interface in org.codehaus.mojo.license.api
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.
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).
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

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.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 This package contains all models of the project.
org.codehaus.mojo.license.nexus - package org.codehaus.mojo.license.nexus
 
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.UpdateProjectLicenseMojo
The directory where to generate license resources.
overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, File) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool
Override licenses from override file.
overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, String) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool
 
overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, File) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool
Override licenses from override file.
overrideLicenses(LicenseMap, SortedMap<String, MavenProject>, String, String) - Method in interface org.codehaus.mojo.license.api.ThirdPartyTool
 

P

parseLicense(String) - Method in class org.codehaus.mojo.license.nexus.LicenseProcessor
 
parseLicenseSummary(InputStream) - Static method in class org.codehaus.mojo.license.utils.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.
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).
ProjectLicenseInfo - Class in org.codehaus.mojo.license.model
Contains the license information for a single project/dependency
ProjectLicenseInfo() - Constructor for class org.codehaus.mojo.license.model.ProjectLicenseInfo
Default constructor.
ProjectLicenseInfo(String, String, String) - Constructor for class org.codehaus.mojo.license.model.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, 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.
rejectPackaging(String...) - Method in class org.codehaus.mojo.license.AbstractLicenseMojo
Accept the project's packaging if not in given one.
removeEmptyLicenses() - Method in class org.codehaus.mojo.license.model.LicenseMap
 
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
 
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
 
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.
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
 
setAddJavaLicenseAfterPackage(boolean) - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer
setArtifactId(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
setArtifactId(String) - Method in class org.codehaus.mojo.license.model.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.
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
 
setDeclaredLicenses(List<ComponentInfo.License>) - Method in class org.codehaus.mojo.license.nexus.ComponentInfo
 
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.Dependency
 
setDescription(String) - Method in class org.codehaus.mojo.license.model.License
 
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.
setExcludedScopes(String) - Method in class org.codehaus.mojo.license.AbstractDownloadLicensesMojo
 
setFileHeader(FileHeader) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter
 
setFileNameOffVersion(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
setGroupId(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
setGroupId(String) - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
setHeaderURL(URL) - Method in class org.codehaus.mojo.license.model.License
 
setHiddenLicense(String) - Method in class org.codehaus.mojo.license.AbstractAddThirdPartyMojo.HiddenLicenses
Add a simple a include license to the list.
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
 
setLicenseId(String) - Method in class org.codehaus.mojo.license.nexus.ComponentInfo.License
 
setLicenseLink(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
setLicenseName(String) - Method in class org.codehaus.mojo.license.nexus.ComponentInfo.License
 
setLicenseResolutionResult(String) - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
setLicenses(List<License>) - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
setLicenseType(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
setLicenseURL(URL) - Method in class org.codehaus.mojo.license.model.License
 
setLog(Log) - Method in class org.codehaus.mojo.license.header.FileHeaderFilter
Sets the logger.
setModification(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
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.Dependency
 
setName(String) - Method in class org.codehaus.mojo.license.model.License
 
setObservedLicenses(List<ComponentInfo.License>) - Method in class org.codehaus.mojo.license.nexus.ComponentInfo
 
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.
setSystem(String) - Method in class org.codehaus.mojo.license.model.Dependency
 
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
 
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
 
setUseNoReformatCommentStartTag(boolean) - Method in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer
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.model.Dependency
 
setVersion(String) - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
 
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.
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
 
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
 

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.
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.
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.
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(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
toString() - Method in class org.codehaus.mojo.license.model.ProjectLicenseInfo
toString() - Method in class org.codehaus.mojo.license.nexus.ComponentInfo.License
 
toString() - Method in class org.codehaus.mojo.license.nexus.ComponentInfo
 
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
 
update(String, String, String) - Method in class org.codehaus.mojo.license.model.Dependency
 
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 licenseName.
UpdateProjectLicenseMojo() - Constructor for class org.codehaus.mojo.license.UpdateProjectLicenseMojo
 
useNoReformatCommentStartTag - Variable in class org.codehaus.mojo.license.header.transformer.JavaFileHeaderTransformer
Flag to use comment start tag with a no reformat syntax /*-.

V

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.FileState
Returns an array containing the constants of this enum type, in the order they are declared.

W

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) - Static method in class org.codehaus.mojo.license.utils.LicenseSummaryWriter
 
writeThirdPartyDependenciesFile(File, String, Set<Dependency>) - Method in class org.codehaus.mojo.license.api.DefaultDependenciesTool
 
writeThirdPartyDependenciesFile(File, String, Set<Dependency>) - Method in interface org.codehaus.mojo.license.api.DependenciesTool
 
writeThirdPartyFile(LicenseMap, File, boolean, String, String, boolean) - Method in class org.codehaus.mojo.license.api.DefaultThirdPartyTool
Write the content of the third-party file.
writeThirdPartyFile(LicenseMap, File, boolean, String, String, boolean) - 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 
Skip navigation links

Copyright © 2010–2023. All rights reserved.