compiler:compile

Full name:

org.apache.maven.plugins:maven-compiler-plugin:2.1:compile

Description:

Compiles application sources

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2.0.
  • Binds by default to the lifecycle phase: compile.

Optional Parameters

Name Type Since Description
compilerArgument String 2.0

Sets the unformatted argument string to be passed to the compiler if fork is set to true.

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
compilerArguments Map 2.0.1

Sets the arguments to be passed to the compiler (prepending a dash) if fork is set to true.

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.
compilerId String 2.0 The compiler id of the compiler to use. See this guide for more information.
Default value is: javac.
compilerVersion String 2.0 Version of the compiler to use, ex. "1.3", "1.5", if fork is set to true.
debug boolean 2.0 Set to true to include debugging information in the compiled class files.
Default value is: true.
debuglevel String 2.1 Keyword list to be appended to the -g command-line switch. Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. If debuglevel is not specified, by default, nothing will be appended to -g. If debug is not turned on, this attribute will be ignored.
encoding String 2.0 The -encoding argument for the Java compiler.
Default value is: ${project.build.sourceEncoding}.
excludes Set 2.0 A list of exclusion filters for the compiler.
executable String 2.0 Sets the executable of the compiler to use when fork is true.
failOnError boolean 2.0.2 Indicates whether the build will continue even if there are compilation errors; defaults to true.
Default value is: true.
fork boolean 2.0 Allows running the compiler in a separate process. If "false" it uses the built in compiler, while if "true" it will use an executable.
Default value is: false.
includes Set 2.0 A list of inclusion filters for the compiler.
maxmem String 2.0.1 Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.
meminitial String 2.0.1 Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.
optimize boolean 2.0 Set to true to optimize the compiled code using the compiler's optimization methods.
Default value is: false.
outputFileName String 2.0 Sets the name of the output file when compiling a set of sources to a single file.
showDeprecation boolean 2.0 Sets whether to show source locations where deprecated APIs are used.
Default value is: false.
showWarnings boolean 2.0 Set to true to show compilation warnings.
Default value is: false.
source String 2.0 The -source argument for the Java compiler.
staleMillis int 2.0 Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
Default value is: 0.
target String 2.0 The -target argument for the Java compiler.
verbose boolean 2.0 Set to true to show messages about what the compiler is doing.
Default value is: false.

Parameter Details

compilerArgument:

Sets the unformatted argument string to be passed to the compiler if fork is set to true.

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.

  • Type: java.lang.String
  • Since: 2.0
  • Required: No

compilerArguments:

Sets the arguments to be passed to the compiler (prepending a dash) if fork is set to true.

This is because the list of valid arguments passed to a Java compiler varies based on the compiler version.

  • Type: java.util.Map
  • Since: 2.0.1
  • Required: No

compilerId:

The compiler id of the compiler to use. See this guide for more information.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.compilerId}
  • Default: javac

compilerVersion:

Version of the compiler to use, ex. "1.3", "1.5", if fork is set to true.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.compilerVersion}

debug:

Set to true to include debugging information in the compiled class files.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.debug}
  • Default: true

debuglevel:

Keyword list to be appended to the -g command-line switch. Legal values are none or a comma-separated list of the following keywords: lines, vars, and source. If debuglevel is not specified, by default, nothing will be appended to -g. If debug is not turned on, this attribute will be ignored.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${maven.compiler.debuglevel}

encoding:

The -encoding argument for the Java compiler.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

excludes:

A list of exclusion filters for the compiler.
  • Type: java.util.Set
  • Since: 2.0
  • Required: No

executable:

Sets the executable of the compiler to use when fork is true.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.executable}

failOnError:

Indicates whether the build will continue even if there are compilation errors; defaults to true.
  • Type: boolean
  • Since: 2.0.2
  • Required: No
  • Expression: ${maven.compiler.failOnError}
  • Default: true

fork:

Allows running the compiler in a separate process. If "false" it uses the built in compiler, while if "true" it will use an executable.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.fork}
  • Default: false

includes:

A list of inclusion filters for the compiler.
  • Type: java.util.Set
  • Since: 2.0
  • Required: No

maxmem:

Sets the maximum size, in megabytes, of the memory allocation pool, ex. "128", "128m" if fork is set to true.
  • Type: java.lang.String
  • Since: 2.0.1
  • Required: No
  • Expression: ${maven.compiler.maxmem}

meminitial:

Initial size, in megabytes, of the memory allocation pool, ex. "64", "64m" if fork is set to true.
  • Type: java.lang.String
  • Since: 2.0.1
  • Required: No
  • Expression: ${maven.compiler.meminitial}

optimize:

Set to true to optimize the compiled code using the compiler's optimization methods.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.optimize}
  • Default: false

outputFileName:

Sets the name of the output file when compiling a set of sources to a single file.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${project.build.finalName}

showDeprecation:

Sets whether to show source locations where deprecated APIs are used.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.showDeprecation}
  • Default: false

showWarnings:

Set to true to show compilation warnings.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.showWarnings}
  • Default: false

source:

The -source argument for the Java compiler.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.source}

staleMillis:

Sets the granularity in milliseconds of the last modification date for testing whether a source needs recompilation.
  • Type: int
  • Since: 2.0
  • Required: No
  • Expression: ${lastModGranularityMs}
  • Default: 0

target:

The -target argument for the Java compiler.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.target}

verbose:

Set to true to show messages about what the compiler is doing.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Expression: ${maven.compiler.verbose}
  • Default: false