Index

A B C E F G H I L O P R S T V
All Classes and Interfaces|All Packages

A

AbstractCheckMojo - Class in org.tentackle.maven.plugin.check

Base class of the check mojos.

AbstractCheckMojo() - Constructor for class org.tentackle.maven.plugin.check.AbstractCheckMojo

B

BundleKey - Class in org.tentackle.maven.plugin.check

A bundle key referenced in the sources via <reference>.getString("<key>").
The key may also be given by a constant, such as <reference>.getString(KEY).

BundleKey(String, String, String) - Constructor for class org.tentackle.maven.plugin.check.BundleKey

Creates a bundle key without a source location.

BundleKey(String, String, String, String) - Constructor for class org.tentackle.maven.plugin.check.BundleKey

Creates a bundle key.

bundleLocales - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

The parsed locales, in the configured order.

C

CheckBundlesMojo - Class in org.tentackle.maven.plugin.check

Verifies all bundle getString() invocations.

CheckBundlesMojo() - Constructor for class org.tentackle.maven.plugin.check.CheckBundlesMojo

Creates a mojo.

CheckBundlesScanner - Class in org.tentackle.maven.plugin.check

Tree path scanner for bundle getString() method invocations.
Collects the invocations of getString with a single argument that refer to a bundle, i.e. a static method of a bundle class, such as AppBundle.getString("key"), or a method of a ResourceBundle, such as getBundle().getString("key").
The key must be a compile-time constant expression of string literals and constant variables, such as "key", KEY, Keys.GREETING or PREFIX + "title".

CheckBundlesScanner() - Constructor for class org.tentackle.maven.plugin.check.CheckBundlesScanner

CheckValidationsMojo - Class in org.tentackle.maven.plugin.check

Verifies all annotation-based validations.
Scans for validator annotations (annotated with @Validation), creates the validators and their compound values for the annotation's value, message and condition.

CheckValidationsMojo() - Constructor for class org.tentackle.maven.plugin.check.CheckValidationsMojo

Creates a mojo.

CheckValidationsProcessor - Class in org.tentackle.maven.plugin.check

Validations checker processor.
Creates a validator for each occurrence of a validation annotation, including repeated ones.

CheckValidationsProcessor() - Constructor for class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Creates the processor.

CheckValidationsProcessor.ValidatorEntry - Record Class in org.tentackle.maven.plugin.check

Validator entry.
Holds the validator and the class where the annotation was found.

className() - Method in record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Returns the value of the className record component.

classpathElements - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

The project's compile classpath.
Includes the project's own output directory, so the compiled classes and copied resources of the project are found as well.

E

equals(Object) - Method in record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Indicates whether some other object is "equal to" this one.

execute() - Method in class org.tentackle.tentackle_check_maven_plugin.HelpMojo

F

finishExecute() - Method in class org.tentackle.maven.plugin.check.CheckBundlesMojo

finishExecute() - Method in class org.tentackle.maven.plugin.check.CheckValidationsMojo

G

getBundleKeys() - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

Gets the collected bundle keys.

getBundleName() - Method in class org.tentackle.maven.plugin.check.BundleKey

Gets the name of the bundle the key belongs to.

getDefaultProcOption() - Method in class org.tentackle.maven.plugin.check.CheckBundlesMojo

getErrors() - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Gets the error count.

getExecutionLock() - Method in class org.tentackle.maven.plugin.check.AbstractCheckMojo

getKey() - Method in class org.tentackle.maven.plugin.check.BundleKey

Gets the bundle key.

getLocation() - Method in class org.tentackle.maven.plugin.check.BundleKey

Gets the source location of the method invocation.
Formatted as <file>:[<line>,<column>], like the messages of the maven compiler.

getName() - Method in class org.tentackle.maven.plugin.check.BundleKey

Gets the reference getString is invoked on.
Qualified by the matching single-type import or, if there is none, by the package of the class.

getPath() - Method in class org.tentackle.maven.plugin.check.BundleKey

Gets the name of the class containing the method invocation.

getProcessingClassLoader() - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Gets the classloader to be used instead of the default.

getSkippedKeys() - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

Gets the getString invocations that were ignored because they don't refer to a bundle.
This includes the invocations referring to the bundle of a class annotated with NoBundle.

getUnresolvedKeys() - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

Gets the collected bundle keys whose invocation could not be resolved, unless suppressed.
Those keys are checked nevertheless, i.e. they are contained in CheckBundlesScanner.getBundleKeys() as well.

getUnverifiedKeys() - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

Gets the getString invocations that refer to a bundle or could not be resolved, but whose argument is not a compile-time constant, unless suppressed.
The key of those bundle keys is the source text of the argument expression.

getValidators() - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Gets the validators found.

H

hashCode() - Method in record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Returns a hash code value for this object.

HelpMojo - Class in org.tentackle.tentackle_check_maven_plugin

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

HelpMojo() - Constructor for class org.tentackle.tentackle_check_maven_plugin.HelpMojo

I

initializeProcessor(AbstractTentackleProcessor, File) - Method in class org.tentackle.maven.plugin.check.CheckValidationsMojo

L

locales - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

The locales to check the bundles and validation messages against.
A comma, semicolon or whitespace separated list.

O

org.tentackle.maven.plugin.check - package org.tentackle.maven.plugin.check

Maven plugin for build-time checks of resource bundle keys and annotation-based validations.

org.tentackle.tentackle_check_maven_plugin - package org.tentackle.tentackle_check_maven_plugin

P

prepareExecute() - Method in class org.tentackle.maven.plugin.check.AbstractCheckMojo

process(Set, RoundEnvironment) - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

processAnnotation(TypeElement, TypeElement, AnnotationMirror, RoundEnvironment) - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Processes the annotation.

R

runCompilationTask(JavaCompiler.CompilationTask) - Method in class org.tentackle.maven.plugin.check.CheckBundlesMojo

Attributes the sources and scans them for getString invocations.

S

scan(JavacTask, Iterable) - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

Scans the attributed compilation units of a task.

scriptingLanguage - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

The default scripting language of the validator scripts.
Required if scripts use the shorthand {...} instead of naming their language explicitly, such as #!groovy{...}.

setProcessingClassLoader(ClassLoader) - Method in class org.tentackle.maven.plugin.check.CheckValidationsProcessor

Sets the classloader to be used instead of the default.

skipTests - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

Skips the checks.
Bound to skipTests, so -DskipTests skips them together with the unit tests.

sourceDir - Variable in class org.tentackle.maven.plugin.check.AbstractCheckMojo

Directory holding the sources to be processed.
Defaults to all Java sources of the current project.

T

toString() - Method in class org.tentackle.maven.plugin.check.BundleKey

toString() - Method in record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Returns a string representation of this record class.

V

validate() - Method in class org.tentackle.maven.plugin.check.AbstractCheckMojo

validator() - Method in record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Returns the value of the validator record component.

ValidatorEntry(Validator, String) - Constructor for record class org.tentackle.maven.plugin.check.CheckValidationsProcessor.ValidatorEntry

Creates an instance of a ValidatorEntry record class.

visitMethodInvocation(MethodInvocationTree, Trees) - Method in class org.tentackle.maven.plugin.check.CheckBundlesScanner

A B C E F G H I L O P R S T V
All Classes and Interfaces|All Packages