Index (license-maven-plugin 3.0 API)

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

A

AbstractCallback() - Constructor for class com.mycila.maven.plugin.license.AbstractLicenseMojo.AbstractCallback
AbstractLicenseMojo - Class in com.mycila.maven.plugin.license: Date: 18-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
AbstractLicenseMojo() - Constructor for class com.mycila.maven.plugin.license.AbstractLicenseMojo
AbstractLicenseMojo.AbstractCallback - Class in com.mycila.maven.plugin.license
AdditionalHeaderDefinition - Class in com.mycila.maven.plugin.license.header: The class AdditionalHeaderDefinition is used to collect header definitions declared in an "external" XML document configuration.
AdditionalHeaderDefinition(XMLTag) - Constructor for class com.mycila.maven.plugin.license.header.AdditionalHeaderDefinition: Construct an AdditionalHeaderDefinition object using the given XML document as header definitions input.
aggregate - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: You can set this flag to true if you want to check the headers for all modules of your project.
allowBlankLines() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
applyDefinitionAndSections(HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header
asOneLineString() - Method in class com.mycila.maven.plugin.license.header.Header
asString() - Method in class com.mycila.maven.plugin.license.header.Header

B

basedir - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: The base directory, in which to search for project files.
buildForDefinition(HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header

C

Callback - Interface in com.mycila.maven.plugin.license: Date: 18-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
checkUnknown() - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo.AbstractCallback
com.mycila.maven.plugin.license - package com.mycila.maven.plugin.license
com.mycila.maven.plugin.license.document - package com.mycila.maven.plugin.license.document
com.mycila.maven.plugin.license.header - package com.mycila.maven.plugin.license.header
com.mycila.maven.plugin.license.util - package com.mycila.maven.plugin.license.util
com.mycila.maven.plugin.license.util.resource - package com.mycila.maven.plugin.license.util.resource
concurrencyFactor - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Maven license plugin uses concurrency to check license headers.
content - Variable in class com.mycila.maven.plugin.license.header.HeaderSource
copyFileToFolder(File, File) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
createDocuments(String) - Method in class com.mycila.maven.plugin.license.document.DocumentFactory
Credentials - Class in com.mycila.maven.plugin.license: Simple wrapper class to transport login/password information.
Credentials(String, String) - Constructor for class com.mycila.maven.plugin.license.Credentials

D

debug(String, Object...) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo
Default - Class in com.mycila.maven.plugin.license
Default() - Constructor for class com.mycila.maven.plugin.license.Default
defaultDefinitions() - Static method in enum com.mycila.maven.plugin.license.header.HeaderType: Returns the header definitions of every default definitions declared by this enumeration as a map using the header type name as key.
defaultMapping() - Static method in enum com.mycila.maven.plugin.license.document.DocumentType
delete(int, int) - Method in class com.mycila.maven.plugin.license.util.FileContent
Document - Class in com.mycila.maven.plugin.license.document: Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
Document(File, HeaderDefinition, String, String[], DocumentPropertiesLoader) - Constructor for class com.mycila.maven.plugin.license.document.Document
DocumentFactory - Class in com.mycila.maven.plugin.license.document: Date: 14-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
DocumentFactory(File, Map<String, String>, Map<String, HeaderDefinition>, String, String[], DocumentPropertiesLoader) - Constructor for class com.mycila.maven.plugin.license.document.DocumentFactory
DocumentPropertiesLoader - Interface in com.mycila.maven.plugin.license.document
DocumentType - Enum in com.mycila.maven.plugin.license.document: Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
dryRun - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: If dryRun is enabled, calls to license:format and license:remove will not overwrite the existing file but instead write the result to a new file with the same name but ending with `.licensed`.

E

encoding - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specify the encoding of your files.
endReached() - Method in class com.mycila.maven.plugin.license.util.FileContent
eol(boolean) - Method in class com.mycila.maven.plugin.license.header.Header
equals(Object) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
errorMessage - Variable in class com.mycila.maven.plugin.license.LicenseCheckMojo
excludes - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specifies files, which are excluded in the check.
EXCLUDES - Static variable in class com.mycila.maven.plugin.license.Default
execute(Callback) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo
execute() - Method in class com.mycila.maven.plugin.license.HelpMojo
execute() - Method in class com.mycila.maven.plugin.license.LicenseCheckMojo
execute() - Method in class com.mycila.maven.plugin.license.LicenseFormatMojo
execute() - Method in class com.mycila.maven.plugin.license.LicenseRemoveMojo

F

failIfMissing - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: You can set this flag to false if you do not want the build to fail when some headers are missing.
failIfUnknown - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: You can leave this flag on false if you do not want the build to fail for files that do not have an implicit or explicit comment style definition.
FileContent - Class in com.mycila.maven.plugin.license.util
FileContent(File, String) - Constructor for class com.mycila.maven.plugin.license.util.FileContent
FileUtils - Class in com.mycila.maven.plugin.license.util: Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
findCredentials(String) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Retrieves the credentials for the given server or null if none could be found
findResource(String) - Method in class com.mycila.maven.plugin.license.util.resource.ResourceFinder: Find a resource by searching: 1.
fromName(String) - Static method in enum com.mycila.maven.plugin.license.header.HeaderType: Returns the HeaderType declared in this enumeration for the given header type name.

G

getAdditionalProperties(AbstractLicenseMojo, Properties, Document) - Method in interface com.mycila.maven.plugin.license.PropertiesProvider
getAfterEachLine() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
getBasedir() - Method in class com.mycila.maven.plugin.license.util.Selection
getBeforeEachLine() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
getBeginPosition() - Method in class com.mycila.maven.plugin.license.header.HeaderParser: Returns the index position in the content where the header effectively starts.
getContent() - Method in class com.mycila.maven.plugin.license.document.Document
getContent() - Method in class com.mycila.maven.plugin.license.header.HeaderSource
getContent() - Method in class com.mycila.maven.plugin.license.util.FileContent
getDefaultHeaderType() - Method in enum com.mycila.maven.plugin.license.document.DocumentType
getDefaultHeaderTypeName() - Method in enum com.mycila.maven.plugin.license.document.DocumentType
getDefaultValue() - Method in class com.mycila.maven.plugin.license.HeaderSection
getDefinition() - Method in enum com.mycila.maven.plugin.license.header.HeaderType: Returns the HeaderDefinition which corresponds to this enumeration instance.
getDefinitions() - Method in class com.mycila.maven.plugin.license.header.AdditionalHeaderDefinition: Returns the header definitions declared by the external header definition as a map using the header type name as key.
getEncoding() - Method in class com.mycila.maven.plugin.license.document.Document
getEndLine() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
getEndPosition() - Method in class com.mycila.maven.plugin.license.header.HeaderParser: Returns the index position in the content where the header effectively ends.
getEnsureMatch() - Method in class com.mycila.maven.plugin.license.HeaderSection
getExcluded() - Method in class com.mycila.maven.plugin.license.util.Selection
getExtension() - Method in enum com.mycila.maven.plugin.license.document.DocumentType
getFile() - Method in class com.mycila.maven.plugin.license.document.Document
getFileContent() - Method in class com.mycila.maven.plugin.license.header.HeaderParser: Returns the file content.
getFilePath() - Method in class com.mycila.maven.plugin.license.document.Document
getFirstLine() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
getHeaderDefinition() - Method in class com.mycila.maven.plugin.license.document.Document
getHeaderDefinition() - Method in class com.mycila.maven.plugin.license.header.HeaderParser: Returns the header definition associated to this header parser (itself bounded to a file).
getIncluded() - Method in class com.mycila.maven.plugin.license.util.Selection
getKey() - Method in class com.mycila.maven.plugin.license.HeaderSection
getLineCount() - Method in class com.mycila.maven.plugin.license.header.Header
getLines() - Method in class com.mycila.maven.plugin.license.header.Header
getLocation() - Method in class com.mycila.maven.plugin.license.header.Header: Returns the location of license template file.
getLogin() - Method in class com.mycila.maven.plugin.license.Credentials
getMaxLineLength() - Method in class com.mycila.maven.plugin.license.header.Header
getPassword() - Method in class com.mycila.maven.plugin.license.Credentials
getPosition() - Method in class com.mycila.maven.plugin.license.util.FileContent
getSelectedFiles() - Method in class com.mycila.maven.plugin.license.util.Selection
getSkipLinePattern() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
getType() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
gotAnyHeader() - Method in class com.mycila.maven.plugin.license.header.HeaderParser: Tells if the given file already contains a license header.

H

hashCode() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
hasHeader(Header, boolean) - Method in class com.mycila.maven.plugin.license.document.Document
header - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Location of the header.
Header - Class in com.mycila.maven.plugin.license.header: The Header class wraps the license template file, the one which have to be outputted inside the other files.
Header(HeaderSource, HeaderSection[]) - Constructor for class com.mycila.maven.plugin.license.header.Header: Constructs a Header object pointing to a license template file.
HeaderDefinition - Class in com.mycila.maven.plugin.license.header: The HeaderDefinition class defines what is needed to output a header text into the of the given file type and what is needed to match the first line as well as the last line of a previous header of the given file type.
HeaderDefinition(String, String, String, String, String, String, String, String, boolean, boolean, boolean) - Constructor for class com.mycila.maven.plugin.license.header.HeaderDefinition: Constructs a new HeaderDefinition object with every header definition properties.
HeaderDefinition(String) - Constructor for class com.mycila.maven.plugin.license.header.HeaderDefinition: Constructs a new HeaderDefinition with only initializing the header type.
headerDefinitions - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Allows the use of external header definitions files.
headerDetected() - Method in class com.mycila.maven.plugin.license.document.Document
HeaderParser - Class in com.mycila.maven.plugin.license.header: The HeaderParser class is used to get header information about the current header defined in the given file.
HeaderParser(FileContent, HeaderDefinition, String[]) - Constructor for class com.mycila.maven.plugin.license.header.HeaderParser: Creates a HeaderParser object linked to the given file content and the associated header definition based on the file type.
HeaderSection - Class in com.mycila.maven.plugin.license
HeaderSection() - Constructor for class com.mycila.maven.plugin.license.HeaderSection
headerSections - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: HeadSections define special regions of a header that allow for dynamic substitution and validation
HeaderSource - Class in com.mycila.maven.plugin.license.header: Provides an access to the license template text.
HeaderSource(String, boolean) - Constructor for class com.mycila.maven.plugin.license.header.HeaderSource
HeaderSource.LiteralHeaderSource - Class in com.mycila.maven.plugin.license.header: A HeaderSource built from a lincense header template literal.
HeaderSource.UrlHeaderSource - Class in com.mycila.maven.plugin.license.header: A HeaderSource loaded from a URL.
HeaderType - Enum in com.mycila.maven.plugin.license.header: Defines the default header definitions available out of the box within this plugin.
HelpMojo - Class in com.mycila.maven.plugin.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 com.mycila.maven.plugin.license.HelpMojo

I

INCLUDE - Static variable in class com.mycila.maven.plugin.license.Default
includes - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specifies files, which are included in the check.
info(String, Object...) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo
inlineHeader - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Header, as text, directly in pom file
insert(int, String) - Method in class com.mycila.maven.plugin.license.util.FileContent
is(Header) - Method in class com.mycila.maven.plugin.license.document.Document
isFirstHeaderLine(String) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition: Tells if the given content line is the first line of a possible header of this definition kind.
isFromUrl(URL) - Method in class com.mycila.maven.plugin.license.header.HeaderSource: Retuns true if this HeaderSource was loaded from the URL given in the location parameter or false otherwise.
isFromUrl(URL) - Method in class com.mycila.maven.plugin.license.header.HeaderSource.LiteralHeaderSource
isFromUrl(URL) - Method in class com.mycila.maven.plugin.license.header.HeaderSource.UrlHeaderSource
isInline() - Method in class com.mycila.maven.plugin.license.header.HeaderSource
isLastHeaderLine(String) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition: Tells if the given content line is the last line of a possible header of this definition kind.
isMatchForText(String, HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header: Determines if a potential file header (typically, the start of the file plus some buffer space) matches this header, as rendered with the specified HeaderDefinition and line-ending.
isMatchForText(String, String, HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header
isMatchForText(Document, HeaderDefinition, boolean, String) - Method in class com.mycila.maven.plugin.license.header.Header
isMultiLine() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
isMultiLineMatch() - Method in class com.mycila.maven.plugin.license.HeaderSection
isNotSupported() - Method in class com.mycila.maven.plugin.license.document.Document
isPadLines() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
isSkipLine(String) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition: Tells if the given content line must be skipped according to this header definition.
isUnix() - Method in class com.mycila.maven.plugin.license.util.FileContent

K

keywords - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specify the list of keywords to use to detect a header.

L

LicenseCheckMojo - Class in com.mycila.maven.plugin.license: Check if the source files of the project have a valid license header
LicenseCheckMojo() - Constructor for class com.mycila.maven.plugin.license.LicenseCheckMojo
LicenseFormatMojo - Class in com.mycila.maven.plugin.license: Reformat files with a missing header to add it
LicenseFormatMojo() - Constructor for class com.mycila.maven.plugin.license.LicenseFormatMojo
LicenseRemoveMojo - Class in com.mycila.maven.plugin.license: Remove the specified header from source files
LicenseRemoveMojo() - Constructor for class com.mycila.maven.plugin.license.LicenseRemoveMojo
LiteralHeaderSource(String) - Constructor for class com.mycila.maven.plugin.license.header.HeaderSource.LiteralHeaderSource
load(Document) - Method in interface com.mycila.maven.plugin.license.document.DocumentPropertiesLoader

M

mapping - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Set mapping between document mapping and a supported type to use.
mergeProperties(String) - Method in class com.mycila.maven.plugin.license.document.Document
missingHeaders - Variable in class com.mycila.maven.plugin.license.LicenseCheckMojo

N

nextLine() - Method in class com.mycila.maven.plugin.license.util.FileContent

O

of(String, String, ResourceFinder) - Static method in class com.mycila.maven.plugin.license.header.HeaderSource
of(String, String, String, ResourceFinder) - Static method in class com.mycila.maven.plugin.license.header.HeaderSource: Checking the params left to right, returns the first available HeaderSource that can be created.
onExistingHeader(Document, Header) - Method in interface com.mycila.maven.plugin.license.Callback
onHeaderNotFound(Document, Header) - Method in interface com.mycila.maven.plugin.license.Callback
onUnknownFile(Document, Header) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo.AbstractCallback
onUnknownFile(Document, Header) - Method in interface com.mycila.maven.plugin.license.Callback

P

padRight(String, int) - Static method in class com.mycila.maven.plugin.license.util.StringUtils
parseHeader() - Method in class com.mycila.maven.plugin.license.document.Document
project - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo
properties - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: You can set here some properties that you want to use when reading the header file.
PropertiesProvider - Interface in com.mycila.maven.plugin.license

Q

quiet - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: If you do not want to see the list of file having a missing header, you can add the quiet flag that will shorten the output

R

read(URL, String, Map<String, String>) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
read(URL, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
read(File, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
readFirstLines(File, int, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
remove(String, String...) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
removeDuplicatedEmptyEndLines() - Method in class com.mycila.maven.plugin.license.util.FileContent
removeHeader() - Method in class com.mycila.maven.plugin.license.document.Document
reset() - Method in class com.mycila.maven.plugin.license.util.FileContent
resetTo(int) - Method in class com.mycila.maven.plugin.license.util.FileContent
ResourceFinder - Class in com.mycila.maven.plugin.license.util.resource: Date: 26-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
ResourceFinder(File) - Constructor for class com.mycila.maven.plugin.license.util.resource.ResourceFinder
rewind() - Method in class com.mycila.maven.plugin.license.util.FileContent
rtrim(String) - Static method in class com.mycila.maven.plugin.license.util.StringUtils

S

save() - Method in class com.mycila.maven.plugin.license.document.Document
saveTo(File) - Method in class com.mycila.maven.plugin.license.document.Document
Selection - Class in com.mycila.maven.plugin.license.util: Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
Selection(File, String[], String[], boolean) - Constructor for class com.mycila.maven.plugin.license.util.Selection
setCompileClassPath(List<String>) - Method in class com.mycila.maven.plugin.license.util.resource.ResourceFinder
setDefaultValue(String) - Method in class com.mycila.maven.plugin.license.HeaderSection
setEnsureMatch(String) - Method in class com.mycila.maven.plugin.license.HeaderSection
setKey(String) - Method in class com.mycila.maven.plugin.license.HeaderSection
setMultiLineMatch(boolean) - Method in class com.mycila.maven.plugin.license.HeaderSection
setPluginClassPath(ClassLoader) - Method in class com.mycila.maven.plugin.license.util.resource.ResourceFinder
setPropertyFromString(String, String) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition: Sets header definition properties using its property name and its string value.
If you want to set a property to null you must not call this function.
skip - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Whether to skip the plugin execution
skipExistingHeaders - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Skip the formatting of files which already contain a detected header.
strictCheck - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Set to true if you need a strict check against the headers.
StringUtils - Class in com.mycila.maven.plugin.license.util

T

toString() - Method in class com.mycila.maven.plugin.license.document.Document
toString() - Method in class com.mycila.maven.plugin.license.header.Header
toString() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
toString() - Method in class com.mycila.maven.plugin.license.header.HeaderSource.LiteralHeaderSource
toString() - Method in class com.mycila.maven.plugin.license.header.HeaderSource.UrlHeaderSource
toString() - Method in class com.mycila.maven.plugin.license.util.FileContent

U

updateHeader(Header) - Method in class com.mycila.maven.plugin.license.document.Document
UrlHeaderSource(URL, String) - Constructor for class com.mycila.maven.plugin.license.header.HeaderSource.UrlHeaderSource
useDefaultExcludes - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specify if you want to use default exclusions besides the files you have excluded.
useDefaultMapping - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Whether to use the default mapping between file extensions and comment types, or only the one your provide.

V

validate() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition: Checks this header definition consistency, in other words if all the mandatory properties of the definition have been set.
validHeaders - Variable in class com.mycila.maven.plugin.license.AbstractLicenseMojo: Specifies additional header files to use when checking for the presence of a valid header in your sources.
valueOf(String) - Static method in enum com.mycila.maven.plugin.license.document.DocumentType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mycila.maven.plugin.license.header.HeaderType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mycila.maven.plugin.license.document.DocumentType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mycila.maven.plugin.license.header.HeaderType: Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String, Object...) - Method in class com.mycila.maven.plugin.license.AbstractLicenseMojo
write(File, String, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils

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