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

A

AbstractLicensePolicyEnforcer<T> - Class in com.mycila.maven.plugin.license.dependencies
Base class for all policy enforcer implementations.
AbstractLicensePolicyEnforcer(LicensePolicy) - Constructor for class com.mycila.maven.plugin.license.dependencies.AbstractLicensePolicyEnforcer
 
ACTIONSCRIPT - com.mycila.maven.plugin.license.document.DocumentType
 
ADA_BODY - com.mycila.maven.plugin.license.document.DocumentType
 
ADA_SPEC - com.mycila.maven.plugin.license.document.DocumentType
 
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.
adjustProperties(AbstractLicenseMojo, Map<String, String>, Document) - Method in interface com.mycila.maven.plugin.license.PropertiesProvider
 
afterEachLine - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The characters to append after each license header lines.
AggregateLicensePolicyEnforcer - Class in com.mycila.maven.plugin.license.dependencies
Aggregate license policy enforcement with default enforcer bindings based on LicensePolicy.Type.
AggregateLicensePolicyEnforcer(Set<LicensePolicy>) - Constructor for class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
allowBlankLines - Variable in class com.mycila.maven.plugin.license.HeaderStyle
Only for multi-line comments: specify if blank lines are allowed.
allowBlankLines() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
 
APOSTROPHE_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
apply(LicenseMap) - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
Take an LicenseMap implementation, getting its licenseMap and applying the internal set of LicensePolicyEnforcer implementations on them, and returning a mapping of Artifact keys to the boolean enforcement decision made.
apply(Map<License, Set<Artifact>>) - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
Take a map of License keys and the Set of Artifact attributed to them, applying the internal set of LicensePolicyEnforcer implementations on them, and returning a mapping of Artifact keys to the boolean enforcement decision made.
apply(Artifact) - Method in class com.mycila.maven.plugin.license.dependencies.ArtifactLicensePolicyEnforcer
 
apply(License) - Method in class com.mycila.maven.plugin.license.dependencies.LicenseNameLicensePolicyEnforcer
 
apply(License) - Method in class com.mycila.maven.plugin.license.dependencies.LicenseURLLicensePolicyEnforcer
 
apply(T) - Method in interface com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcer
 
applyDefinitionAndSections(HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header
 
APPROVE - com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
 
ARTIFACT_PATTERN - com.mycila.maven.plugin.license.dependencies.LicensePolicy.Type
 
ArtifactLicensePolicyEnforcer - Class in com.mycila.maven.plugin.license.dependencies
Make policy decisions on a Artifact based on an ArtifactFilter.
ArtifactLicensePolicyEnforcer(LicensePolicy) - Constructor for class com.mycila.maven.plugin.license.dependencies.ArtifactLicensePolicyEnforcer
 
ArtifactLicensePolicyEnforcer(LicensePolicy, ArtifactFilter) - Constructor for class com.mycila.maven.plugin.license.dependencies.ArtifactLicensePolicyEnforcer
 
ASCII_DOC - com.mycila.maven.plugin.license.document.DocumentType
 
ASCIIDOC_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
asOneLineString() - Method in class com.mycila.maven.plugin.license.header.Header
 
ASP - com.mycila.maven.plugin.license.document.DocumentType
 
ASP - com.mycila.maven.plugin.license.header.HeaderType
 
asPath(File) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
 
ASPECTJ - com.mycila.maven.plugin.license.document.DocumentType
 
ASSEMBLER - com.mycila.maven.plugin.license.document.DocumentType
 
asString() - Method in class com.mycila.maven.plugin.license.header.Header
 

B

basedir - Variable in class com.mycila.maven.plugin.license.LicenseSet
The base directory, in which to search for project files.
BATCH - com.mycila.maven.plugin.license.header.HeaderType
 
beforeEachLine - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The characters to prepend before each license header lines.
BRACESSTAR_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
buildForDefinition(HeaderDefinition, boolean) - Method in class com.mycila.maven.plugin.license.header.Header
 

C

C - com.mycila.maven.plugin.license.document.DocumentType
 
Callback - Interface in com.mycila.maven.plugin.license
Date: 18-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com)
CLOJURE - com.mycila.maven.plugin.license.document.DocumentType
 
CLOJURESCRIPT - com.mycila.maven.plugin.license.document.DocumentType
 
close() - Method in interface com.mycila.maven.plugin.license.PropertiesProvider
 
COLDFUSION_COMPONENT - com.mycila.maven.plugin.license.document.DocumentType
 
COLDFUSION_ML - com.mycila.maven.plugin.license.document.DocumentType
 
com.mycila.maven.plugin.license - package com.mycila.maven.plugin.license
 
com.mycila.maven.plugin.license.dependencies - package com.mycila.maven.plugin.license.dependencies
 
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
 
content - Variable in class com.mycila.maven.plugin.license.header.HeaderSource
 
copyFilesToFolder(File, File) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
 
copyFileToFolder(File, File) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
 
CPP - com.mycila.maven.plugin.license.document.DocumentType
 
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
 
CSHARP - com.mycila.maven.plugin.license.document.DocumentType
 
CSS - com.mycila.maven.plugin.license.document.DocumentType
 

D

Default - Class in com.mycila.maven.plugin.license
 
DEFAULT_SEPARATOR - Static variable in class com.mycila.maven.plugin.license.Multi
 
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.
DefaultLicensePolicyEnforcer - Class in com.mycila.maven.plugin.license.dependencies
A default deny ArtifactLicensePolicyEnforcer.
DefaultLicensePolicyEnforcer() - Constructor for class com.mycila.maven.plugin.license.dependencies.DefaultLicensePolicyEnforcer
 
defaultMapping() - Static method in enum com.mycila.maven.plugin.license.document.DocumentType
 
defaultValue - Variable in class com.mycila.maven.plugin.license.HeaderSection
The default value that will be used.
delete(int, int) - Method in class com.mycila.maven.plugin.license.util.FileContent
 
DELPHI - com.mycila.maven.plugin.license.document.DocumentType
 
DENY - com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
 
DOCKERFILE - com.mycila.maven.plugin.license.document.DocumentType
 
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)
DOUBLEDASHES_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
DOUBLESLASH_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
DOUBLETILDE_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
DOXIA_APT - com.mycila.maven.plugin.license.document.DocumentType
 
DOXIA_FAQ - com.mycila.maven.plugin.license.document.DocumentType
 
DTD - com.mycila.maven.plugin.license.document.DocumentType
 
DYNASCRIPT_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
DYNASCRIPT3_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 

E

EDITORCONFIG - com.mycila.maven.plugin.license.document.DocumentType
 
EIFFEL - com.mycila.maven.plugin.license.document.DocumentType
 
endLine - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The last fixed line of this header.
endReached() - Method in class com.mycila.maven.plugin.license.util.FileContent
 
ensureMatch - Variable in class com.mycila.maven.plugin.license.HeaderSection
The pattern to use to match this section in the header.
eol(boolean) - Method in class com.mycila.maven.plugin.license.header.Header
 
equals(Object) - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
equals(Object) - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
equals(Object) - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
 
ERLANG - com.mycila.maven.plugin.license.document.DocumentType
 
ERLANG_HEADER - com.mycila.maven.plugin.license.document.DocumentType
 
EXCLAMATION_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
EXCLAMATION3_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
excludes - Variable in class com.mycila.maven.plugin.license.LicenseSet
Specifies files, which are excluded in the check.
EXCLUDES - Static variable in class com.mycila.maven.plugin.license.Default
 
exportTo(File) - Method in class com.mycila.maven.plugin.license.Report
 

F

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)
findResource(String) - Method in class com.mycila.maven.plugin.license.util.resource.ResourceFinder
Find a resource by searching: 1.
firstLine - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The first fixed line of this header.
firstLineDetectionPattern - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The regex used to detect the start of a header section or line
FORTRAN - com.mycila.maven.plugin.license.document.DocumentType
 
FREEMARKER - com.mycila.maven.plugin.license.document.DocumentType
 
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.
FTL - com.mycila.maven.plugin.license.header.HeaderType
 
FTL_ALT - com.mycila.maven.plugin.license.header.HeaderType
 

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
 
getArtifact() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
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
 
getDefaultPolicy() - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
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.
getEnforcers() - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
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).
getHeaders() - Method in class com.mycila.maven.plugin.license.Multi
 
getIncluded() - Method in class com.mycila.maven.plugin.license.util.Selection
 
getInlineHeaders() - Method in class com.mycila.maven.plugin.license.Multi
 
getKey() - Method in class com.mycila.maven.plugin.license.HeaderSection
 
getLicense() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
getLicenseMap() - Method in interface com.mycila.maven.plugin.license.dependencies.LicenseMap
 
getLicenseMap() - Method in class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
 
getLicenseMapFromArtifacts(Set<Artifact>) - Method in class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
Get mapping of Licenses to a set of artifacts presenting that license.
getLicensesFromArtifact(Artifact) - Method in class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
Return a set of licenses attributed to a single artifact.
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
 
getPolicies() - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
getPolicy() - Method in class com.mycila.maven.plugin.license.dependencies.AbstractLicensePolicyEnforcer
 
getPolicy() - Method in interface com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcer
 
getPolicy() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
getPosition() - Method in class com.mycila.maven.plugin.license.util.FileContent
 
getPreamble() - Method in class com.mycila.maven.plugin.license.Multi
 
getPredicate() - Method in enum com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
Get a boolean form of a rule.
getProjects() - Method in class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
 
getRule() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
getRuling() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
getSelectedFiles() - Method in class com.mycila.maven.plugin.license.util.Selection
 
getSeparators() - Method in class com.mycila.maven.plugin.license.Multi
 
getSkipLinePattern() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
 
getType() - Method in class com.mycila.maven.plugin.license.dependencies.ArtifactLicensePolicyEnforcer
 
getType() - Method in class com.mycila.maven.plugin.license.dependencies.LicenseNameLicensePolicyEnforcer
 
getType() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
getType() - Method in interface com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcer
 
getType() - Method in class com.mycila.maven.plugin.license.dependencies.LicenseURLLicensePolicyEnforcer
 
getType() - Method in class com.mycila.maven.plugin.license.header.HeaderDefinition
 
getValue() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
gotAnyHeader() - Method in class com.mycila.maven.plugin.license.header.HeaderParser
Tells if the given file already contains a license header.
GRADLE - com.mycila.maven.plugin.license.document.DocumentType
 
GRADLE_KOTLIN - com.mycila.maven.plugin.license.document.DocumentType
 
GROOVY - com.mycila.maven.plugin.license.document.DocumentType
 
GSP - com.mycila.maven.plugin.license.document.DocumentType
 

H

H - com.mycila.maven.plugin.license.document.DocumentType
 
HAML - com.mycila.maven.plugin.license.document.DocumentType
 
HAML_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
hashCode() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
hashCode() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
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.LicenseSet
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) - Constructor for class com.mycila.maven.plugin.license.header.HeaderDefinition
Constructs a new HeaderDefinition with only initializing the header 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.
headerDefinitions - Variable in class com.mycila.maven.plugin.license.LicenseSet
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.LicenseSet
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 license header template literal.
HeaderSource.MultiLiteralHeaderSource - Class in com.mycila.maven.plugin.license.header
A HeaderSource built from multiple license header template literals.
HeaderSource.MultiUrlHeaderSource - Class in com.mycila.maven.plugin.license.header
A HeaderSource loaded from multiple URL.
HeaderSource.UrlHeaderSource - Class in com.mycila.maven.plugin.license.header
A HeaderSource loaded from a URL.
HeaderStyle - Class in com.mycila.maven.plugin.license
 
HeaderStyle() - Constructor for class com.mycila.maven.plugin.license.HeaderStyle
 
HeaderType - Enum in com.mycila.maven.plugin.license.header
Defines the default header definitions available out of the box within this plugin.
HTM - com.mycila.maven.plugin.license.document.DocumentType
 
HTML - com.mycila.maven.plugin.license.document.DocumentType
 

I

INCLUDE - Static variable in class com.mycila.maven.plugin.license.Default
 
includes - Variable in class com.mycila.maven.plugin.license.LicenseSet
Specifies files, which are included in the check.
INFO_DEPS_DISCOVERED - Static variable in interface com.mycila.maven.plugin.license.dependencies.LicenseMessage
 
INFO_LICENSE_IMPL - Static variable in interface com.mycila.maven.plugin.license.dependencies.LicenseMessage
 
init(AbstractLicenseMojo, Map<String, String>) - Method in interface com.mycila.maven.plugin.license.PropertiesProvider
 
inlineHeader - Variable in class com.mycila.maven.plugin.license.LicenseSet
Header, as text, directly in pom file.
inlineHeaderStyles - Variable in class com.mycila.maven.plugin.license.LicenseSet
Allows the use of inline header definitions within the POM.
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
 
isAllowed() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
isAllowed(boolean) - Method in enum com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
Simple policy decision based on whether a matcher succeeded.
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.MultiLiteralHeaderSource
 
isFromUrl(URL) - Method in class com.mycila.maven.plugin.license.header.HeaderSource.MultiUrlHeaderSource
 
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(Document, HeaderDefinition, boolean, String) - Method in class com.mycila.maven.plugin.license.header.Header
 
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
 
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
 

J

JAVA - com.mycila.maven.plugin.license.document.DocumentType
 
JAVADOC_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
JAVAFX - com.mycila.maven.plugin.license.document.DocumentType
 
JAVAPKG_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
JAVASCRIPT - com.mycila.maven.plugin.license.document.DocumentType
 
JSP - com.mycila.maven.plugin.license.document.DocumentType
 
JSPX - com.mycila.maven.plugin.license.document.DocumentType
 

K

key - Variable in class com.mycila.maven.plugin.license.HeaderSection
The name of this section to match.
keywords - Variable in class com.mycila.maven.plugin.license.LicenseSet
Specify the list of keywords to use to detect a header.
KML - com.mycila.maven.plugin.license.document.DocumentType
 
KOTLIN - com.mycila.maven.plugin.license.document.DocumentType
 

L

lastLineDetectionPattern - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The regex used to detect the end of a header section or line
LICENSE_NAME - com.mycila.maven.plugin.license.dependencies.LicensePolicy.Type
 
LICENSE_URL - com.mycila.maven.plugin.license.dependencies.LicensePolicy.Type
 
LicenseMap - Interface in com.mycila.maven.plugin.license.dependencies
To be implemented by different project/build-framework scanners presenting licenses of dependencies.
LicenseMessage - Interface in com.mycila.maven.plugin.license.dependencies
Expose message text to config and tests.
LicenseNameLicensePolicyEnforcer - Class in com.mycila.maven.plugin.license.dependencies
Make policy decisions on a License based on the license name.
LicenseNameLicensePolicyEnforcer(LicensePolicy) - Constructor for class com.mycila.maven.plugin.license.dependencies.LicenseNameLicensePolicyEnforcer
 
LicensePolicy - Class in com.mycila.maven.plugin.license.dependencies
A policy decision based on some matcher/value and type.
LicensePolicy() - Constructor for class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
LicensePolicy(LicensePolicy.Rule, LicensePolicy.Type, String) - Constructor for class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
LicensePolicy.Rule - Enum in com.mycila.maven.plugin.license.dependencies
 
LicensePolicy.Type - Enum in com.mycila.maven.plugin.license.dependencies
 
LicensePolicyEnforcer<T> - Interface in com.mycila.maven.plugin.license.dependencies
Methods exposed by enforcer implementations using LicensePolicy.
LicensePolicyEnforcerResult - Class in com.mycila.maven.plugin.license.dependencies
 
LicensePolicyEnforcerResult(LicensePolicy, License, Artifact, LicensePolicy.Rule) - Constructor for class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
LicenseSet - Class in com.mycila.maven.plugin.license
 
LicenseSet() - Constructor for class com.mycila.maven.plugin.license.LicenseSet
 
LicenseURLLicensePolicyEnforcer - Class in com.mycila.maven.plugin.license.dependencies
Make policy decisions on a License based on the license URL.
LicenseURLLicensePolicyEnforcer(LicensePolicy) - Constructor for class com.mycila.maven.plugin.license.dependencies.LicenseURLLicensePolicyEnforcer
 
LISP - com.mycila.maven.plugin.license.document.DocumentType
 
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
 
LUA - com.mycila.maven.plugin.license.document.DocumentType
 
LUA - com.mycila.maven.plugin.license.header.HeaderType
 

M

MavenProjectLicenses - Class in com.mycila.maven.plugin.license.dependencies
Helper class for building Artifact/License mappings from a maven project (multi module or single).
MavenProjectLicenses(MavenSession, MavenProject, DependencyGraphBuilder, ProjectBuilder, List<String>, Log) - Constructor for class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
 
mergeProperties(String) - Method in class com.mycila.maven.plugin.license.document.Document
 
multi - Variable in class com.mycila.maven.plugin.license.LicenseSet
Alternative to `header`, `inlineHeader`, or `validHeaders` for use when code is multi-licensed.
Multi - Class in com.mycila.maven.plugin.license
 
Multi() - Constructor for class com.mycila.maven.plugin.license.Multi
 
multiLine - Variable in class com.mycila.maven.plugin.license.HeaderStyle
Specify whether this is a multi-line comment style or not.
MultiLiteralHeaderSource(String, String[], String[]) - Constructor for class com.mycila.maven.plugin.license.header.HeaderSource.MultiLiteralHeaderSource
 
MultiUrlHeaderSource(String, URL[], String[], String) - Constructor for class com.mycila.maven.plugin.license.header.HeaderSource.MultiUrlHeaderSource
 
MUSTACHE - com.mycila.maven.plugin.license.document.DocumentType
 
MUSTACHE_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
MVEL - com.mycila.maven.plugin.license.document.DocumentType
 
MVEL_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
MXML - com.mycila.maven.plugin.license.document.DocumentType
 

N

name - Variable in class com.mycila.maven.plugin.license.HeaderStyle
The name of this header style
nextLine() - Method in class com.mycila.maven.plugin.license.util.FileContent
 

O

of(Multi, 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.
of(String, String, ResourceFinder) - Static method in class com.mycila.maven.plugin.license.header.HeaderSource
 
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 interface com.mycila.maven.plugin.license.Callback
 

P

padLines - Variable in class com.mycila.maven.plugin.license.HeaderStyle
Only for non multi-line comments: specify if some spaces should be added after the header line and before the HeaderStyle.afterEachLine characters so that all the lines are aligned.
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
 
PERCENT_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
PERCENT3_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
PERL - com.mycila.maven.plugin.license.document.DocumentType
 
PERL_MODULE - com.mycila.maven.plugin.license.document.DocumentType
 
PHP - com.mycila.maven.plugin.license.document.DocumentType
 
PHP - com.mycila.maven.plugin.license.header.HeaderType
 
POM - com.mycila.maven.plugin.license.document.DocumentType
 
properties - Variable in class com.mycila.maven.plugin.license.LicenseSet
You can set here some properties that you want to use when reading the header file.
PROPERTIES - com.mycila.maven.plugin.license.document.DocumentType
 
PropertiesProvider - Interface in com.mycila.maven.plugin.license
 
PROTO - com.mycila.maven.plugin.license.document.DocumentType
 
PYTHON - com.mycila.maven.plugin.license.document.DocumentType
 

R

read(File, 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(URL, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
 
read(URL, String, Map<String, Object>) - 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
 
Report - Class in com.mycila.maven.plugin.license
 
Report(String, Report.Action, MavenProject, Clock, boolean) - Constructor for class com.mycila.maven.plugin.license.Report
 
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(Path) - 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
 
RUBY - com.mycila.maven.plugin.license.document.DocumentType
 

S

save() - Method in class com.mycila.maven.plugin.license.document.Document
 
saveTo(File) - Method in class com.mycila.maven.plugin.license.document.Document
 
SCALA - com.mycila.maven.plugin.license.document.DocumentType
 
SCALA_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
SCAML - com.mycila.maven.plugin.license.document.DocumentType
 
SCRIPT_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
SCSS - com.mycila.maven.plugin.license.document.DocumentType
 
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, Log) - Constructor for class com.mycila.maven.plugin.license.util.Selection
 
SEMICOLON_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
setCompileClassPath(List<String>) - Method in class com.mycila.maven.plugin.license.util.resource.ResourceFinder
 
setDefaultPolicy(LicensePolicyEnforcer) - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
setDefaultValue(String) - Method in class com.mycila.maven.plugin.license.HeaderSection
 
setEnforcers(Set<LicensePolicyEnforcer>) - Method in class com.mycila.maven.plugin.license.dependencies.AggregateLicensePolicyEnforcer
 
setEnsureMatch(String) - Method in class com.mycila.maven.plugin.license.HeaderSection
 
setHeader(String) - Method in class com.mycila.maven.plugin.license.Multi
Set a header.
setHeaders(String[]) - Method in class com.mycila.maven.plugin.license.Multi
 
setInlineHeader(String) - Method in class com.mycila.maven.plugin.license.Multi
Set an inline header.
setInlineHeaders(String[]) - Method in class com.mycila.maven.plugin.license.Multi
 
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
 
setPreamble(String) - Method in class com.mycila.maven.plugin.license.Multi
 
setProjects(Set<MavenProject>) - Method in class com.mycila.maven.plugin.license.dependencies.MavenProjectLicenses
 
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.
setSeparator(String) - Method in class com.mycila.maven.plugin.license.Multi
Set a separator.
setSeparators(String[]) - Method in class com.mycila.maven.plugin.license.Multi
 
SHARPSTAR_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
SHELL - com.mycila.maven.plugin.license.document.DocumentType
 
SINGLE_LINE_DOUBLESLASH_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
skipLinePattern - Variable in class com.mycila.maven.plugin.license.HeaderStyle
A regex to define a first line in a file that should be skipped and kept untouched, like the XML declaration at the top of XML documents
SLASHSTAR_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
SPRING_FACTORIES - com.mycila.maven.plugin.license.document.DocumentType
 
SQL - com.mycila.maven.plugin.license.document.DocumentType
 
StringUtils - Class in com.mycila.maven.plugin.license.util
 

T

TAGX - com.mycila.maven.plugin.license.document.DocumentType
 
TEX - com.mycila.maven.plugin.license.document.DocumentType
 
TEX_CLASS - com.mycila.maven.plugin.license.document.DocumentType
 
TEX_STYLE - com.mycila.maven.plugin.license.document.DocumentType
 
TEXT - com.mycila.maven.plugin.license.header.HeaderType
 
TLD - com.mycila.maven.plugin.license.document.DocumentType
 
toHeaderDefinition() - Method in class com.mycila.maven.plugin.license.HeaderStyle
 
toString() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicy
 
toString() - Method in class com.mycila.maven.plugin.license.dependencies.LicensePolicyEnforcerResult
 
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.MultiLiteralHeaderSource
 
toString() - Method in class com.mycila.maven.plugin.license.header.HeaderSource.MultiUrlHeaderSource
 
toString() - Method in class com.mycila.maven.plugin.license.header.HeaderSource.UrlHeaderSource
 
toString() - Method in class com.mycila.maven.plugin.license.util.FileContent
 
TRIPLESLASH_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
TS - com.mycila.maven.plugin.license.document.DocumentType
 
TXT - com.mycila.maven.plugin.license.document.DocumentType
 

U

UNKNOWN - com.mycila.maven.plugin.license.document.DocumentType
 
UNKNOWN - com.mycila.maven.plugin.license.header.HeaderType
 
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.LicenseSet
Specify if you want to use default exclusions besides the files you have excluded.

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.LicenseSet
Specifies additional header files to use when checking for the presence of a valid header in your sources.
valueOf(boolean) - Static method in enum com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mycila.maven.plugin.license.dependencies.LicensePolicy.Rule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mycila.maven.plugin.license.dependencies.LicensePolicy.Type
Returns the enum constant of this type with the specified name.
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.dependencies.LicensePolicy.Rule
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.dependencies.LicensePolicy.Type
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.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.
VB - com.mycila.maven.plugin.license.document.DocumentType
 
VBA - com.mycila.maven.plugin.license.document.DocumentType
 
VELOCITY - com.mycila.maven.plugin.license.document.DocumentType
 

W

WARN_POLICY_DENIED - Static variable in interface com.mycila.maven.plugin.license.dependencies.LicenseMessage
 
WINDOWS_BATCH - com.mycila.maven.plugin.license.document.DocumentType
 
WINDOWS_SHELL - com.mycila.maven.plugin.license.document.DocumentType
 
write(File, String, String) - Static method in class com.mycila.maven.plugin.license.util.FileUtils
 
WSDL - com.mycila.maven.plugin.license.document.DocumentType
 

X

XHTML - com.mycila.maven.plugin.license.document.DocumentType
 
XML - com.mycila.maven.plugin.license.document.DocumentType
 
XML_PER_LINE - com.mycila.maven.plugin.license.header.HeaderType
 
XML_STYLE - com.mycila.maven.plugin.license.header.HeaderType
 
XSD - com.mycila.maven.plugin.license.document.DocumentType
 
XSL - com.mycila.maven.plugin.license.document.DocumentType
 
XSLT - com.mycila.maven.plugin.license.document.DocumentType
 

Y

YAML - com.mycila.maven.plugin.license.document.DocumentType
 
YML - com.mycila.maven.plugin.license.document.DocumentType
 
A B C D E F G H I J K L M N O P R S T U V W X Y 
All Classes All Packages