eclipse-format:format

Full name:

net.sf.maven.plugins:maven-eclipse-format:1.1-SNAPSHOT:format

Description:

Format java source files with the Eclipse java formatter.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: process-sources.

Optional Parameters

Name Type Since Description
failOnError boolean - Indicates whether a run should be held if errors occured.
Default value is: true.
fileEncoding String - Sets the file encoding.
Default value is: UTF-8.
fileFormat String - Sets the file format of the input files. The file format controls what end of line character is used. Either one of "UNIX", "DOS", "MAC", "DEFAULT" or "AUTO" can be used. The values are case insensitive.
Default value is: auto.
formatConfig String - Path to alternative formatter configuration.
srcExcludesPattern String - For Source Directory. Specifies filesets defining which source files not to format. This is a comma- or space-separated list of patterns of files. Default value is **\*.exc.
srcIncludesPattern String - For Source Directory. Specifies filesets defining which source files to format. This is a comma- or space-separated list of patterns of files.
Default value is: **\*.java.
testExcludesPattern String - For Test Directory. Specifies filesets defining which test source files not to format. This is a comma- or space-separated list of patterns of files. Default value is **\\*.exc.
testIncludesPattern String - For Test Directory. Specifies filesets defining which test source files to format. This is a comma- or space-separated list of patterns of files.
Default value is: **\*.java.

Parameter Details

failOnError:

Indicates whether a run should be held if errors occured.
  • Type: boolean
  • Required: No
  • Default: true

fileEncoding:

Sets the file encoding.
  • Type: java.lang.String
  • Required: No
  • Default: UTF-8

fileFormat:

Sets the file format of the input files. The file format controls what end of line character is used. Either one of "UNIX", "DOS", "MAC", "DEFAULT" or "AUTO" can be used. The values are case insensitive.
  • Type: java.lang.String
  • Required: No
  • Default: auto

formatConfig:

Path to alternative formatter configuration.
  • Type: java.lang.String
  • Required: No

srcExcludesPattern:

For Source Directory. Specifies filesets defining which source files not to format. This is a comma- or space-separated list of patterns of files. Default value is **\*.exc.
  • Type: java.lang.String
  • Required: No
  • Expression: **\*.exc

srcIncludesPattern:

For Source Directory. Specifies filesets defining which source files to format. This is a comma- or space-separated list of patterns of files.
  • Type: java.lang.String
  • Required: No
  • Default: **\*.java

testExcludesPattern:

For Test Directory. Specifies filesets defining which test source files not to format. This is a comma- or space-separated list of patterns of files. Default value is **\\*.exc.
  • Type: java.lang.String
  • Required: No
  • Expression: **\*.exc

testIncludesPattern:

For Test Directory. Specifies filesets defining which test source files to format. This is a comma- or space-separated list of patterns of files.
  • Type: java.lang.String
  • Required: No
  • Default: **\*.java