Usage

In order to integrate Jalopy into your build process, you need to edit your pom.xml under the plugins section:

<project>
  [...]
  <plugins>
    <plugin>
      <groupId>triemax</groupId>
      <artifactId>jalopy-maven</artifactId>
      <configuration>
        [...]
      </configuration>
      <executions>
        <execution>
          <phase>process-classes</phase>
          <goals>
            <goal>format</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    [...]
  </plugins>
</project>

This would execute Jalopy during the process-classes phase. Please note that you should always apply formatting after the compile phase has finished in order to ensure that the project is clean, but you’re otherwise free to choose the phase that best suits your needs. For more information about the Maven build lifecycle, please refer to the “Maven Build Lifecycle Guide”. It contains a reference of the available build phases. If you don’t want to have the format goal execute during the build, you simply don’t bind the goal to a specific phase:

<project>
  [...]
  <plugins>
    <plugin>
      <groupId>triemax</groupId>
      <artifactId>jalopy-maven</artifactId>
      <configuration>
        [...]
      </configuration>
    </plugin>
    [...]
  </plugins>
</project>

Formatting can be manually triggered from the command-line using either

% mvn triemax:jalopy-maven:format

or the shorthand

% mvn jalopy:format

Configuration

Naturally the Plug-in provides a few parameters to configure its behavior.

Table 11.1. Jalopy Maven Plug-in parameters

Property	Type	Description	Since
backup	Boolean	Sets whether backup copies of all processed source files should be kept. When omitted, the corresponding code convention setting will be used (see the section called “Backup”)	1.7
classpathElements	List	Defines the class path to use for type lookup. By default, the project class path ${project.compileClasspathElements} is used	1.7
convention	String	Sets the location of the code convention file to use - given either relative to the project’s base directory or as an absolute local path or Internet address (refer to the section called “Import code convention” for information how to export your settings). When omitted and not specified otherwise (see “profile” below), the settings of the current profile are used Since Jalopy 1.9.3, it’s also possible to load conventions from the class path. This can be achieved with the following syntax: <convention>classpath:[path]<convention> where [path] denotes the relative path to the resource in the artifact, e.g. jalopy.xml if the settings file can be found at the root level, or config/jalopy/sonar.xml when located in a nested folder	1.7
destDir	String	Sets the destination directory to create/copy all formatting output into. If the given directory does not exist, it will be created. When omitted, all input files will simply be overridden	1.7
encoding	String	Sets the encoding that controls how Jalopy interprets text files containing characters beyond the ASCII character set. Defaults to the platform default encoding	1.7
environment	Map	Defines temporary environment variables overrides	1.7
excludes	List	A list of exclusion filters. Uses the standard Maven pattern syntax. Please note that Jalopy ignores all files it cannot format by default, so exclusions are only necessary if you want to omit formatting for certain files, like e.g. test data files etc.	1.7
failOnError	Boolean	Sets whether a run should be held if errors occurred. Defaults to “true”	1.7
fileFormat	String	Sets the file format of the output files. The file format controls what end of line character is used. Either one of “UNIX”, “DOS”, “DEFAULT” or “AUTO” can be used (case insensitive). Defaults to “AUTO”	1.7
force	Boolean	Sets whether the formatting of files should be forced, even if a file is up-to-date. Defaults to “false”	1.7
fork	Boolean	Sets whether the processing should be performed in a separate VM. Defaults to “false”	1.7
history	String	Sets the history policy to use. Either one of “ADLER32”, “CRC32” or “NONE” can be used (case insensitive). If omitted, the corresponding code convention setting will used (see the section called “History”)	1.7
includes	List	A list of inclusion filters for formatting. Uses the standard Maven pattern syntax. Please note that Jalopy ignores all files it cannot format by default, so inclusions are only necessary if you want to omit formatting for certain files, like e.g. test data files etc.	1.7
inputEncoding	String	Sets the encoding that controls how Jalopy interprets text files containing characters beyond the ASCII character set. Defaults to the platform default encoding. Please note that this setting always overrides encoding	1.7
javadoc	String	Indicates whether Javadoc related messages should be printed. Defaults to “true”	1.7
logLevel	String	Specifies the logging level for message output. Either one of “ERROR”, “WARN”, “INFO” or “DEBUG” can be used (case insensitive). When omitted, the current code convention settings will be used (see the section called “Categories”)	1.7
logFile	String	Specifies the log file to use for logging output. The format of the logging output is determined by the extension of the given file. Valid extensions are `“.log”` for a custom plain text format, `“.xml”` for a plain XML format and `“.html”` for a hierarchical HTML report. When omitted, the current code convention setting will be used (see the section called “Logging”)	1.7
outputEncoding	String	Sets the character encoding Jalopy uses to write files. Defaults to the platform default encoding. Please note that this setting always overrides encoding	1.7
profile	String	Sets the Jalopy profile that should be used during the formatting run (refer to the section called “Main window” for more information about profiles). The currently active profile will be restored after formatting. Please note that if no convention is specified, the profile must exist!	1.7
repository	Boolean	Indicates whether the disk-based type repository should be used for type lookup. You may want to disable the disk-based type repository if you commonly format a single file or only a small set of files in order to avoid the maintenance overhead of the type repository. Defaults to “true”	1.7
sources	List	The source directories containing the sources to be formatted. When omitted, uses the directories defined for the compiler (${project.compileSourceRoots}) instead	1.7
test	Boolean	Sets whether formatting output should actually be written to disk. If set to “true” no output will be written to disk. The default is “false”	1.7
threads	Integer	Specifies the number of processing threads to use. Integer between `1` - `8`. Defaults to '1';	1.7

To configure the Plug-in, you specify elements named after the available parameters where the contents of an element is the value to be assigned to the parameter.

<plugin>
  <groupId>triemax</groupId>
  <artifactId>jalopy-maven</artifactId>
  <configuration>
    <threads>4</threads>
    <profile>test</profile>
  </configuration>
  [...]
</plugin>

For parameters of type List you would use multiple element tags to add the different values to the list.

<plugin>
  <groupId>triemax</groupId>
  <artifactId>jalopy-maven</artifactId>
  <configuration>
    <includes>
      <include>com/foo/siri/**</include>
      <include>com/foo/lana/**</include>
    </includes>
    <excludes>
      <exclude>**/*.sqlj</exclude>
      <exclude>**/*Test/**</exclude>
    </excludes>
    [...]
  </configuration>
</plugin>

Configuring Maps works similar: elements are named after the keys and the element contents is the value to be assigned to the key.

<plugin>
  <groupId>triemax</groupId>
  <artifactId>jalopy-maven</artifactId>
  <configuration>
    <environment>
      <lead>John Doo</lead>
      <office>Alta Nova</office>
    </environment>
    [...]
  </configuration>
</plugin>

For a complete example, please refer to the section called “Example” below.