eclipse-formatter:format

Full name:

org.kuali.maven.plugins:maven-eclipse-formatter-plugin:1.1:format

Description:

A plugin for executing the Eclipse java source code formatter

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Since version: 1.0.

Required Parameters

Name Type Since Description
application String 1.0 This is the name of the Eclipse application that performs the formatting
Default value is: org.eclipse.jdt.core.JavaCodeFormatter.
eclipseBinary String 1.0 Full path to the Eclipse executable binary
formatterPreferences String 1.0 Pointer to an Eclipse "org.eclipse.jdt.core.prefs" file. Supports "classpath:" style notation
Default value is: classpath:eclipse.prefs.

Optional Parameters

Name Type Since Description
eclipseArgs String[] 1.0 Any arguments specified here are passed to the Eclipse binary as additional command line arguments. Default values are "-nosplash -verbose"
excludes String[] 1.0 Regular expressions for directories to exclude from the process that scans for *.java files
includes String[] 1.0 Regular expressions for directories that contain Java source code to format. Default value is **/src/main/java. The Eclipse formatter will recursively inspect any directories matching these patterns for *.java files
javaBinaries String[] 1.0 Binaries representing a Java VM. Default values are "javaw.exe", "java.exe", and "java". This list is searched in order, stopping as soon as one is found.
skip boolean 1.0.1 Skip the execution.
Default value is: false.
vm String 1.0 Full path to a Java VM. This gets filled in using the system property "java.home" unless a value is supplied here.

Parameter Details

application:

This is the name of the Eclipse application that performs the formatting
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${eclipse.application}
  • Default: org.eclipse.jdt.core.JavaCodeFormatter

eclipseArgs:

Any arguments specified here are passed to the Eclipse binary as additional command line arguments. Default values are "-nosplash -verbose"
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

eclipseBinary:

Full path to the Eclipse executable binary
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${eclipse.binary}

excludes:

Regular expressions for directories to exclude from the process that scans for *.java files
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

formatterPreferences:

Pointer to an Eclipse "org.eclipse.jdt.core.prefs" file. Supports "classpath:" style notation
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Expression: ${eclipse.formatterPreferences}
  • Default: classpath:eclipse.prefs

includes:

Regular expressions for directories that contain Java source code to format. Default value is **/src/main/java. The Eclipse formatter will recursively inspect any directories matching these patterns for *.java files
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

javaBinaries:

Binaries representing a Java VM. Default values are "javaw.exe", "java.exe", and "java". This list is searched in order, stopping as soon as one is found.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

skip:

Skip the execution.
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • Expression: ${skip}
  • Default: false

vm:

Full path to a Java VM. This gets filled in using the system property "java.home" unless a value is supplied here.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${eclipse.vm}