Questions? Don’t hesitate to ask. We love to help!

Explains the steps involved in getting the Maven 2 Plug-in up and running.

..
  repository
    [...]
    triemax
      jalopy
        1.9.3-156
          jalopy-1.9.3-156.jar
          jalopy-1.9.3-156.pom
      jalopy-maven
        1.9.3-156
          jalopy-maven-1.9.3-156.jar
          jalopy-maven-1.9.3-156.pom
          maven-metadata-local.xml
        maven-metadata-central.xml
    [...]

Although Jalopy ships with sensible default settings (mimicking the Sun Java coding convention), you most likely want to configure the formatter to match your needs (adding copyright headers, tune Javadoc handling and the like). For such, Jalopy comes with a graphical configuration tool that lets you interactively customize the settings. See Chapter 2, Configuration for an in-depth discussion of the available options.

To display the configuration tool, you can use the configure goal from within Maven. Either using the complete notation

% mvn triemax:jalopy-maven:configure

or just the shorthand

% mvn jalopy:configure

When you’re done configuring the settings, you should export the code convention as described in Section 2.1.1.8, “Export code convention”. The exported settings file is typically used as part of the Jalopy plugin configuration in the build script.

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.

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 Section 11.4, “Example” below.

Below you find a complete POM that performs formatting after each compile run finished successfully, disables logging of Javadoc related messages, only displays messages with warning severity or higher, activates the profile “test” during formatting and imports the code convention jalopy.xml from the build-config artifact. Formatting is applied to all Java source files of the project that are not located below the “testdata” folder.

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>testing</groupId>
  <artifactId>test</artifactId>
  <packaging>jar</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>Maven Quick Start Archetype</name>
  <url>http://maven.apache.org</url>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>triemax</groupId>
        <artifactId>jalopy-maven</artifactId>
        <configuration>
          <javadoc>false</javadoc>
          <logLevel>warn</logLevel>
          <convention>classpath:jalopy.xml</convention>
          <sources>
            <source>/work/foo/main/src/java</source>
            <source>/work/foo/test/src/java</source>
          </sources>
          <includes>
            <include>**/*.java</include>
          </includes>
          <excludes>
            <exclude>**/testdata/**</exclude>
          </excludes>
          <environment>
            <lead>John Doo</lead>
            <office>Alta Nova</office>
          </environment>
        </configuration>
        <dependencies>
          <!-- Import the artifact that provides the code convention -->
          <dependency>
            <groupId>com.mycompany</groupId>
            <artifactId>build-config</artifactId>
            <version>1.0.2</version>
          </dependency>
        </dependencies>
        <executions>
          <execution>
            <phase>process-classes</phase>
            <goals>
              <goal>format</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>