Built by Maven

tentackle-check:bundles

Full name:

org.tentackle:tentackle-check-maven-plugin:21.16.1.0:bundles

Description:

Verifies all bundle getString() invocations.

Finds all invocations of <reference>.getString(<string-literal>).
Where <reference> is:

  • a bundle classname, e.g. BlahBundle.getString("foo") checked against BlahBundle properties.
  • a method that refers to a bundle with the same name as the class containing the method invocation, e.g. getBundle().getString("foo") in class Blah corresponds to the key "foo" in Blah.properties.
  • a variable or constant: same as method, i.e. the bundle name is that of the containing class, e.g. resources.getString("foo").
If a class must not be checked for bundle keys, it needs to be excluded from the fileset.

The following cases are not covered by this mojo:

  • all non-literals, e.g. getBundle().getString(text) as often found in enums. Needs explicit tests.
  • PdoBundles, i.e. translations for @Singular, @Plural. See PdoUtilitiesTest.
  • ValidationBundles, i.e. translations in validators, are covered by the mojo tentackle-check:validations.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
<sourceDir> File - Directory holding the sources to be processed.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
Default: ${project.build.sourceDirectory}
User Property: tentackle.sourceDir

Optional Parameters

Name Type Since Description
<charset> String - The encoding to read and write files.
Default: ${project.build.sourceEncoding}
<compilerArgs> List<String> - Arguments to be passed to the compiler.
(see maven-compiler-plugin)
<compilerArgument> String - Sets the unformatted single argument string to be passed to the compiler.
(see maven-compiler-plugin)
<encoding> String - Source file encode.
Default: ${project.build.sourceEncoding}
<filesets> List<FileSet> - The list of file sets.
If set the source directory is ignored.
<jdkToolchain> Map<String,String> - Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.

Example:

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin: 
  <jdkToolchain></jdkToolchain>
<locales> String - The locales to check the bundles against.
Defaults to the current locale.
The fallback locale should come first.
<minLogLevel> String - The minimum logging java.util.logging.Level to redirect java.util logging to the maven logger.
Default: WARNING
<scriptingLanguage> String - Sets the default scripting language to be used in validators.
<showCompileOutput> boolean - Show compile output.
Default: ${tentackle.showCompileOutput}
<skip> Boolean - Skips processing.
Defaults to true if packaging is "pom".
<skipTests> boolean - True whether to skip this test.
Default: ${skipTests}
<verbosity> String - The verbosity.
One of "default", "info" or "debug". Debug is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
Default: ${tentackle.verbosity}

Parameter Details

<charset>

The encoding to read and write files.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<compilerArgs>

Arguments to be passed to the compiler.
(see maven-compiler-plugin)
  • Type: java.util.List<java.lang.String>
  • Required: No

<compilerArgument>

Sets the unformatted single argument string to be passed to the compiler.
(see maven-compiler-plugin)
  • Type: java.lang.String
  • Required: No

<encoding>

Source file encode.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

<filesets>

The list of file sets.
If set the source directory is ignored.
  • Type: java.util.List<org.apache.maven.shared.model.fileset.FileSet>
  • Required: No

<jdkToolchain>

Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.

Example:

  <jdkToolchain>
    <version>14</version>
  </jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin: 
  <jdkToolchain></jdkToolchain>
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Required: No

<locales>

The locales to check the bundles against.
Defaults to the current locale.
The fallback locale should come first.
  • Type: java.lang.String
  • Required: No

<minLogLevel>

The minimum logging java.util.logging.Level to redirect java.util logging to the maven logger.
  • Type: java.lang.String
  • Required: No
  • Default: WARNING

<scriptingLanguage>

Sets the default scripting language to be used in validators.
  • Type: java.lang.String
  • Required: No

<showCompileOutput>

Show compile output.
  • Type: boolean
  • Required: No
  • Default: ${tentackle.showCompileOutput}

<skip>

Skips processing.
Defaults to true if packaging is "pom".
  • Type: java.lang.Boolean
  • Required: No

<skipTests>

True whether to skip this test.
  • Type: boolean
  • Required: No
  • Default: ${skipTests}

<sourceDir>

Directory holding the sources to be processed.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
  • Type: java.io.File
  • Required: Yes
  • User Property: tentackle.sourceDir
  • Default: ${project.build.sourceDirectory}

<verbosity>

The verbosity.
One of "default", "info" or "debug". Debug is also turned on (if not set explicitly) by Maven's global debug flag (see command line switch -X).
  • Type: java.lang.String
  • Required: No
  • Default: ${tentackle.verbosity}