A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractLicenseMojo - Class in com.google.code.mojo.license
-
Date: 18-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - AbstractLicenseMojo() - Constructor for class com.google.code.mojo.license.AbstractLicenseMojo
- ACTIONSCRIPT - com.google.code.mojo.license.document.DocumentType
- ADA_BODY - com.google.code.mojo.license.document.DocumentType
- ADA_SPEC - com.google.code.mojo.license.document.DocumentType
- AdditionalHeaderDefinition - Class in com.google.code.mojo.license.header
-
The class
AdditionalHeaderDefinition
is used to collect header definitions declared in an "external" XML document configuration. - AdditionalHeaderDefinition(XMLTag) - Constructor for class com.google.code.mojo.license.header.AdditionalHeaderDefinition
-
Construct an
AdditionalHeaderDefinition
object using the given XML document as header definitions input.
- aggregate - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Wheter to treat multi-modules projects as only one project (true) or treat multi-module projects separately (false, by default)
- allowBlankLines() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- APOSTROPHE_STYLE - com.google.code.mojo.license.header.HeaderType
- asOneLineString() - Method in class com.google.code.mojo.license.header.Header
- ASP - com.google.code.mojo.license.document.DocumentType
- ASP - com.google.code.mojo.license.header.HeaderType
- ASPECTJ - com.google.code.mojo.license.document.DocumentType
- ASSEMBLER - com.google.code.mojo.license.document.DocumentType
- asString() - Method in class com.google.code.mojo.license.header.Header
B
- basedir - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
The base directory, in which to search for files.
- BATCH - com.google.code.mojo.license.header.HeaderType
- BRACESSTAR_STYLE - com.google.code.mojo.license.header.HeaderType
- buildForDefinition(HeaderDefinition, boolean) - Method in class com.google.code.mojo.license.header.Header
C
- C - com.google.code.mojo.license.document.DocumentType
- Callback - Interface in com.google.code.mojo.license
-
Date: 18-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - COLDFUSION_COMPONENT - com.google.code.mojo.license.document.DocumentType
- COLDFUSION_ML - com.google.code.mojo.license.document.DocumentType
- com.google.code.mojo.license - package com.google.code.mojo.license
- com.google.code.mojo.license.document - package com.google.code.mojo.license.document
- com.google.code.mojo.license.header - package com.google.code.mojo.license.header
- com.google.code.mojo.license.util - package com.google.code.mojo.license.util
- com.google.code.mojo.license.util.resource - package com.google.code.mojo.license.util.resource
- concurrencyFactor - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Maven license plugin uses concurrency to check license headers.
- copyFileToFolder(File, File) - Static method in class com.google.code.mojo.license.util.FileUtils
- CPP - com.google.code.mojo.license.document.DocumentType
- createDocuments(String) - Method in class com.google.code.mojo.license.document.DocumentFactory
- CSHARP - com.google.code.mojo.license.document.DocumentType
- CSS - com.google.code.mojo.license.document.DocumentType
D
- debug(String, Object...) - Method in class com.google.code.mojo.license.AbstractLicenseMojo
- defaultDefinitions() - Static method in enum com.google.code.mojo.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.google.code.mojo.license.document.DocumentType
- delete(int, int) - Method in class com.google.code.mojo.license.util.FileContent
- DELPHI - com.google.code.mojo.license.document.DocumentType
- Document - Class in com.google.code.mojo.license.document
-
Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - Document(File, HeaderDefinition, String, String[]) - Constructor for class com.google.code.mojo.license.document.Document
- DocumentFactory - Class in com.google.code.mojo.license.document
-
Date: 14-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - DocumentFactory(File, Map<String, String>, Map<String, HeaderDefinition>, String, String[]) - Constructor for class com.google.code.mojo.license.document.DocumentFactory
- DocumentType - Enum in com.google.code.mojo.license.document
-
Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - DOUBLEDASHES_STYLE - com.google.code.mojo.license.header.HeaderType
- DOUBLESLASH_STYLE - com.google.code.mojo.license.header.HeaderType
- DOUBLETILDE_STYLE - com.google.code.mojo.license.header.HeaderType
- DOXIA_APT - com.google.code.mojo.license.document.DocumentType
- DOXIA_FAQ - com.google.code.mojo.license.document.DocumentType
- dryRun - Variable in class com.google.code.mojo.license.LicenseFormatMojo
-
Wheter to treat multi-modules projects as only one project (true) or treat multi-module projects separately (false, by default)
- dryRun - Variable in class com.google.code.mojo.license.LicenseRemoveMojo
-
Wheter to treat multi-modules projects as only one project (true) or treat multi-module projects separately (false, by default)
- DTD - com.google.code.mojo.license.document.DocumentType
- DYNASCRIPT_STYLE - com.google.code.mojo.license.header.HeaderType
- DYNASCRIPT3_STYLE - com.google.code.mojo.license.header.HeaderType
E
- EIFFEL - com.google.code.mojo.license.document.DocumentType
- encoding - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Set the charcter encoding for files
- endReached() - Method in class com.google.code.mojo.license.util.FileContent
- eol(boolean) - Method in class com.google.code.mojo.license.header.Header
- equals(Object) - Method in class com.google.code.mojo.license.header.HeaderDefinition
- ERLANG - com.google.code.mojo.license.document.DocumentType
- ERLANG_HEADER - com.google.code.mojo.license.document.DocumentType
- EXCLAMATION_STYLE - com.google.code.mojo.license.header.HeaderType
- EXCLAMATION3_STYLE - com.google.code.mojo.license.header.HeaderType
- excludes - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Specifies files, which are excluded in the check.
- execute() - Method in class com.google.code.mojo.license.LicenseCheckMojo
- execute() - Method in class com.google.code.mojo.license.LicenseFormatMojo
- execute() - Method in class com.google.code.mojo.license.LicenseRemoveMojo
- execute(Callback) - Method in class com.google.code.mojo.license.AbstractLicenseMojo
F
- failIfMissing - Variable in class com.google.code.mojo.license.LicenseCheckMojo
-
Whether to fail the build if some file miss license header
- FileContent - Class in com.google.code.mojo.license.util
- FileContent(File, String) - Constructor for class com.google.code.mojo.license.util.FileContent
- FileUtils - Class in com.google.code.mojo.license.util
-
Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - findResource(String) - Method in class com.google.code.mojo.license.util.resource.ResourceFinder
-
Find a resource by searching:
1. - FORTRAN - com.google.code.mojo.license.document.DocumentType
- FREEMARKER - com.google.code.mojo.license.document.DocumentType
- fromName(String) - Static method in enum com.google.code.mojo.license.header.HeaderType
-
Returns the
HeaderType
declared in this enumeration for the given header type name. - FTL - com.google.code.mojo.license.header.HeaderType
- FTL_ALT - com.google.code.mojo.license.header.HeaderType
G
- getBasedir() - Method in class com.google.code.mojo.license.util.Selection
- getBeforeEachLine() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- getBeginPosition() - Method in class com.google.code.mojo.license.header.HeaderParser
-
Returns the index position in the content where the header effectively starts.
- getContent() - Method in class com.google.code.mojo.license.document.Document
- getContent() - Method in class com.google.code.mojo.license.util.FileContent
- getDefaultHeaderType() - Method in enum com.google.code.mojo.license.document.DocumentType
- getDefaultHeaderTypeName() - Method in enum com.google.code.mojo.license.document.DocumentType
- getDefinition() - Method in enum com.google.code.mojo.license.header.HeaderType
-
Returns the
HeaderDefinition
which corresponds to this enumeration instance. - getDefinitions() - Method in class com.google.code.mojo.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.google.code.mojo.license.document.Document
- getEndLine() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- getEndPosition() - Method in class com.google.code.mojo.license.header.HeaderParser
-
Returns the index position in the content where the header effectively ends.
- getExcluded() - Method in class com.google.code.mojo.license.util.Selection
- getExtension() - Method in enum com.google.code.mojo.license.document.DocumentType
- getFile() - Method in class com.google.code.mojo.license.document.Document
- getFileContent() - Method in class com.google.code.mojo.license.header.HeaderParser
-
Returns the file content.
- getFirstLine() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- getHeaderDefinition() - Method in class com.google.code.mojo.license.document.Document
- getHeaderDefinition() - Method in class com.google.code.mojo.license.header.HeaderParser
-
Returns the header definition associated to this header parser (itself bounded to a file).
- getIncluded() - Method in class com.google.code.mojo.license.util.Selection
- getLineCount() - Method in class com.google.code.mojo.license.header.Header
- getLines() - Method in class com.google.code.mojo.license.header.Header
- getLocation() - Method in class com.google.code.mojo.license.header.Header
-
Returns the location of license template file.
- getPosition() - Method in class com.google.code.mojo.license.util.FileContent
- getSelectedFiles() - Method in class com.google.code.mojo.license.util.Selection
- getSkipLinePattern() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- getType() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- gotAnyHeader() - Method in class com.google.code.mojo.license.header.HeaderParser
-
Tells if the given file already contains a license header.
- GROOVY - com.google.code.mojo.license.document.DocumentType
- GSP - com.google.code.mojo.license.document.DocumentType
H
- H - com.google.code.mojo.license.document.DocumentType
- HAML - com.google.code.mojo.license.document.DocumentType
- HAML_STYLE - com.google.code.mojo.license.header.HeaderType
- hashCode() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- hasHeader(Header, boolean) - Method in class com.google.code.mojo.license.document.Document
- header - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
The text document containing the license header to check or use for reformatting
- Header - Class in com.google.code.mojo.license.header
-
The
Header
class wraps the license template file, the one which have to be outputted inside the other files. - Header(URL, Map<String, String>) - Constructor for class com.google.code.mojo.license.header.Header
-
Constructs a
Header
object pointing to a license template file. - HeaderDefinition - Class in com.google.code.mojo.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.
Optionally you can define the lines you want to skip before outputting the header. - HeaderDefinition(String) - Constructor for class com.google.code.mojo.license.header.HeaderDefinition
-
Constructs a new
HeaderDefinition
with only initializing the header type. - HeaderDefinition(String, String, String, String, String, String, String, boolean, boolean) - Constructor for class com.google.code.mojo.license.header.HeaderDefinition
-
Constructs a new
HeaderDefinition
object with every header definition properties. - headerDefinitions - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Allows the use of external header definitions files.
- headerDetected() - Method in class com.google.code.mojo.license.document.Document
- HeaderParser - Class in com.google.code.mojo.license.header
-
The
HeaderParser
class is used to get header information about the current header defined in the given file.
The achieve this it will use theHeaderDefinition
associated to the type of the given file. - HeaderParser(FileContent, HeaderDefinition, String[]) - Constructor for class com.google.code.mojo.license.header.HeaderParser
-
Creates a
HeaderParser
object linked to the given file content and the associated header definition based on the file type. - HeaderType - Enum in com.google.code.mojo.license.header
-
Defines the default header definitions available out of the box within this plugin.
- HTM - com.google.code.mojo.license.document.DocumentType
- HTML - com.google.code.mojo.license.document.DocumentType
I
- includes - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Specifies files, which are included in the check.
- info(String, Object...) - Method in class com.google.code.mojo.license.AbstractLicenseMojo
- insert(int, String) - Method in class com.google.code.mojo.license.util.FileContent
- is(Header) - Method in class com.google.code.mojo.license.document.Document
- isFirstHeaderLine(String) - Method in class com.google.code.mojo.license.header.HeaderDefinition
-
Tells if the given content line is the first line of a possible header of this definition kind.
- isLastHeaderLine(String) - Method in class com.google.code.mojo.license.header.HeaderDefinition
-
Tells if the given content line is the last line of a possible header of this definition kind.
- isMultiLine() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- isNotSupported() - Method in class com.google.code.mojo.license.document.Document
- isSkipLine(String) - Method in class com.google.code.mojo.license.header.HeaderDefinition
-
Tells if the given content line must be skipped according to this header definition.
- isUnix() - Method in class com.google.code.mojo.license.util.FileContent
J
- JAVA - com.google.code.mojo.license.document.DocumentType
- JAVADOC_STYLE - com.google.code.mojo.license.header.HeaderType
- JAVAFX - com.google.code.mojo.license.document.DocumentType
- JAVASCRIPT - com.google.code.mojo.license.document.DocumentType
- JSP - com.google.code.mojo.license.document.DocumentType
- JSPX - com.google.code.mojo.license.document.DocumentType
K
- keywords - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Specify the list of keywords to use to detect a header.
- KML - com.google.code.mojo.license.document.DocumentType
L
- LicenseCheckMojo - Class in com.google.code.mojo.license
-
Check if the source files of the project have a valid license header
- LicenseCheckMojo() - Constructor for class com.google.code.mojo.license.LicenseCheckMojo
- LicenseFormatMojo - Class in com.google.code.mojo.license
-
Reformat files with a missing header to add it
- LicenseFormatMojo() - Constructor for class com.google.code.mojo.license.LicenseFormatMojo
- LicenseRemoveMojo - Class in com.google.code.mojo.license
-
Remove the specified header from source files
- LicenseRemoveMojo() - Constructor for class com.google.code.mojo.license.LicenseRemoveMojo
- LISP - com.google.code.mojo.license.document.DocumentType
- listSelectedFiles() - Method in class com.google.code.mojo.license.AbstractLicenseMojo
- LUA - com.google.code.mojo.license.document.DocumentType
- LUA - com.google.code.mojo.license.header.HeaderType
M
- mapping - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Set mapping between document mapping and a supported type to use
- mergeProperties() - Method in class com.google.code.mojo.license.AbstractLicenseMojo
- missingHeaders - Variable in class com.google.code.mojo.license.LicenseCheckMojo
- MXML - com.google.code.mojo.license.document.DocumentType
N
- nextLine() - Method in class com.google.code.mojo.license.util.FileContent
O
- onExistingHeader(Document, Header) - Method in interface com.google.code.mojo.license.Callback
- onHeaderNotFound(Document, Header) - Method in interface com.google.code.mojo.license.Callback
P
- parseHeader() - Method in class com.google.code.mojo.license.document.Document
- PERCENT3_STYLE - com.google.code.mojo.license.header.HeaderType
- PERL - com.google.code.mojo.license.document.DocumentType
- PERL_MODULE - com.google.code.mojo.license.document.DocumentType
- PHP - com.google.code.mojo.license.document.DocumentType
- PHP - com.google.code.mojo.license.header.HeaderType
- POM - com.google.code.mojo.license.document.DocumentType
- project - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
- properties - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
The properties to use when reading the header, to replace tokens
- PROPERTIES - com.google.code.mojo.license.document.DocumentType
- PYTHON - com.google.code.mojo.license.document.DocumentType
Q
- quiet - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Set this to "true" to cause no output
R
- read(File, String) - Static method in class com.google.code.mojo.license.util.FileUtils
- read(URL, Map<String, String>) - Static method in class com.google.code.mojo.license.util.FileUtils
- readFirstLines(File, int, String) - Static method in class com.google.code.mojo.license.util.FileUtils
- remove(String, String...) - Static method in class com.google.code.mojo.license.util.FileUtils
- removeDuplicatedEmptyEndLines() - Method in class com.google.code.mojo.license.util.FileContent
- removeHeader() - Method in class com.google.code.mojo.license.document.Document
- reset() - Method in class com.google.code.mojo.license.util.FileContent
- resetTo(int) - Method in class com.google.code.mojo.license.util.FileContent
- ResourceFinder - Class in com.google.code.mojo.license.util.resource
-
Date: 26-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - ResourceFinder(File) - Constructor for class com.google.code.mojo.license.util.resource.ResourceFinder
- rewind() - Method in class com.google.code.mojo.license.util.FileContent
- rtrim(String) - Static method in class com.google.code.mojo.license.util.StringUtils
- RUBY - com.google.code.mojo.license.document.DocumentType
S
- save() - Method in class com.google.code.mojo.license.document.Document
- saveTo(File) - Method in class com.google.code.mojo.license.document.Document
- SCALA - com.google.code.mojo.license.document.DocumentType
- SCAML - com.google.code.mojo.license.document.DocumentType
- SCRIPT_STYLE - com.google.code.mojo.license.header.HeaderType
- Selection - Class in com.google.code.mojo.license.util
-
Date: 16-Feb-2008
Author: Mathieu Carbou (mathieu.carbou@gmail.com) - Selection(File, String[], String[], boolean) - Constructor for class com.google.code.mojo.license.util.Selection
- SEMICOLON_STYLE - com.google.code.mojo.license.header.HeaderType
- setCompileClassPath(List<String>) - Method in class com.google.code.mojo.license.util.resource.ResourceFinder
- setPluginClassPath(ClassLoader) - Method in class com.google.code.mojo.license.util.resource.ResourceFinder
- setPropertyFromString(String, String) - Method in class com.google.code.mojo.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.
This function is mainly used while parsing properties from the XML configuration file. - SHARPSTAR_STYLE - com.google.code.mojo.license.header.HeaderType
- SHELL - com.google.code.mojo.license.document.DocumentType
- skip - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Whether to skip the plugin execution
- skipExistingHeaders - Variable in class com.google.code.mojo.license.LicenseFormatMojo
-
Wheter to skip file where a header has been detected
- SLASHSTAR_STYLE - com.google.code.mojo.license.header.HeaderType
- SQL - com.google.code.mojo.license.document.DocumentType
- strictCheck - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Set to true if you need a strict check against the headers.
- StringUtils - Class in com.google.code.mojo.license.util
T
- TEXT - com.google.code.mojo.license.header.HeaderType
- toString() - Method in class com.google.code.mojo.license.document.Document
- toString() - Method in class com.google.code.mojo.license.header.Header
- toString() - Method in class com.google.code.mojo.license.header.HeaderDefinition
- toString() - Method in class com.google.code.mojo.license.util.FileContent
- TXT - com.google.code.mojo.license.document.DocumentType
U
- UNKNOWN - com.google.code.mojo.license.document.DocumentType
- UNKNOWN - com.google.code.mojo.license.header.HeaderType
- updateHeader(Header) - Method in class com.google.code.mojo.license.document.Document
- useDefaultExcludes - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Whether to use the default excludes when scanning for files.
- useDefaultMapping - Variable in class com.google.code.mojo.license.AbstractLicenseMojo
-
Whether to use the default mapping between fiel extensions and comments to use, or only the one your provide
V
- validate() - Method in class com.google.code.mojo.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.google.code.mojo.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.google.code.mojo.license.document.DocumentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.google.code.mojo.license.header.HeaderType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.google.code.mojo.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.google.code.mojo.license.header.HeaderType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VB - com.google.code.mojo.license.document.DocumentType
- VELOCITY - com.google.code.mojo.license.document.DocumentType
W
- warn(String, Object...) - Method in class com.google.code.mojo.license.AbstractLicenseMojo
- WINDOWS_BATCH - com.google.code.mojo.license.document.DocumentType
- WINDOWS_SHELL - com.google.code.mojo.license.document.DocumentType
- write(File, String, String) - Static method in class com.google.code.mojo.license.util.FileUtils
X
- XHTML - com.google.code.mojo.license.document.DocumentType
- XML - com.google.code.mojo.license.document.DocumentType
- XML_STYLE - com.google.code.mojo.license.header.HeaderType
- XSD - com.google.code.mojo.license.document.DocumentType
- XSL - com.google.code.mojo.license.document.DocumentType
All Classes All Packages