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

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

.m2
  repository
    ...
    triemax
      jalopy
        1.9.4-108
          jalopy-1.9.4-108.jar
          jalopy-1.9.4-108.pom
      jalopy-maven
        1.9.4-108
          jalopy-maven-1.9.4-108.jar
          jalopy-maven-1.9.4-108.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 described in Section 2.1.1, “Preferences GUI”, you can utilize the configure goal from within Maven. Either using the complete notation

% mvn triemax:jalopy-maven:configure

or just the shorthand

% mvn jalopy:configure

If you should have any of the other plug-ins described in this manual installed, you can of course use their corresponding feature, e.g. invoke the preferences dialog directly from within an IDE. When you’re done configuring the settings, you should export the code convention as described in Section 2.1.1.11, “Export code convention”. The exported settings file is typically used as part of the Jalopy plug-in configuration in the build script.

In order to integrate Jalopy into your build process, you need to edit your pom.xml and add the Jalopy plug-in below the <plugins> section:

<project>
  ...
  <plugins>
    <plugin>
      <groupId>triemax</groupId>
      <artifactId>jalopy-maven</artifactId>
      <version>1.9.4-108</version>
      <configuration>
        <compile>true</compile>
        ...
      </configuration>
      <executions>
        <execution>
          <phase>process-sources</phase>
          <goals>
            <goal>format</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
  ...
</project>

This would execute Jalopy during the process-sources phase, which is probably the most appropriate for standard use. Please note that you typically should apply formatting before the compile phase in order to ensure that formatting does not cause discrepancies between the location information in the compiled .class files and the actual source code. Because Jalopy might still need access the binary project information, you should configure Jalopy to compile the project before formatting as shown above. See Appendix A, “Type Resolution” for the list of features that require access to the class path.

For more information about the Maven build lifecycle, please refer to the “Maven Build Lifecycle Guide” on the Maven home page. 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.

You can display the parameter descriptions from the command line as follows:

$ mvn help:describe -Dcmd=jalopy:format -Ddetail

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>

Parameters might be temporarily overridden from the command-line using system properties following the “jalopy.parameter” notation. This works for all parameters besides those that use Java Collection types, e.g. environment or excludes. Such parameters can only be configured from the POM.

$ mvn -Djalopy.threads=8 -Djalopy.compile=false ...

For a complete sample POM, please refer to Section 11.4, “Example” below.

Below you find a complete POM that makes sure that the binary project information is accessible before formatting, 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>com.google.guava</groupId>
  <artifactId>guava</artifactId>
  <packaging>jar</packaging>
  <version>r05-SNAPSHOT</version>
  <name>Guava: Google Core Libraries for Java 1.5</name>
  <url>http://code.google.com/p/guava-libraries</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <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>
        <version>1.9.4-108</version>
        <configuration>
          <compile>true</compile>
          <convention>classpath:jalopy.xml</convention>
          <javadoc>false</javadoc>
          <logLevel>warn</logLevel>
          <environment>
            <lead>John Doo</lead>
            <office>Alta Nova</office>
          </environment>
          <excludes>
            <exclude>**/testdata/**</exclude>
          </excludes>
          <includes>
            <include>**/*.java</include>
          </includes>
          <sources>
            <source>/work/foo/main/src/java</source>
            <source>/work/foo/test/src/java</source>
          </sources>
        </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-sources</phase>
            <goals>
              <goal>format</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
    <finalName>${project.artifactId}-${project.version}</finalName>
    <sourceDirectory>src</sourceDirectory>
    <testSourceDirectory>tests_disabled</testSourceDirectory>
  </build>
</project>