gwt:eclipse

Full name:

org.codehaus.mojo:gwt-maven-plugin:1.1:eclipse

Description:

Goal which creates Eclipse lauch configurations for GWT modules.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Invokes the execution of the lifecycle phase generate-resources prior to executing itself.

Required Parameters

Name Type Since Description
buildOutputDirectory File - Location of the compiled classes. Default value is: ${project.build.outputDirectory}.
generateDirectory File - Folder where generated-source will be created (automatically added to compile classpath). Default value is: ${project.build.directory}/generated-sources/gwt.

Optional Parameters

Name Type Since Description
additionalPageParameters String - Additional parameters to append to the module URL. For example, gwt-log users will set "log_level=DEBUG"
extraJvmArgs String - Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.

Default value is: -Xmx512m.
gwtHome File - Location on filesystem where GWT is installed - for manual mode (existing GWT on machine). Setting this parameter will disable gwtVersion.
gwtVersion String - GWT version used to build dependency paths, should match the "version" in the Maven repo. If not set, will be autodetected from project com.google.gwt:gwt-user dependency
hostedWebapp File - Location of the hosted-mode web application structure. Default value matches the Google Eclipse plugin. Default value is: ${basedir}/war.
inplace boolean - Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war plugin. Default value is: false.
module String - A single GWT module. Shortcut for <modules> or option to specify a single module from command line
modules String[] - The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
noserver boolean - Run without hosted mode server Default value is: false.
port int - Port of the HTTP server used when noserver is set Default value is: 8080.
useGoogleEclispePlugin boolean - Setup a launch configuration for using the Google Eclipse Plugin. This is the recommended setup, as the home-made launch configuration has many limitations. This parameter is only for backward compatibility, the standard lauch configuration template will be removed in a future release. Default value is: true.
warSourceDirectory File - Location of the web application static resources (same as maven-war-plugin parameter) Default value is: ${basedir}/src/main/webapp.
webappDirectory File - Location on filesystem where GWT will write output files (-out option to GWTCompiler). Default value is: ${project.build.directory}/${project.build.finalName}.

Parameter Details

additionalPageParameters:

Additional parameters to append to the module URL. For example, gwt-log users will set "log_level=DEBUG"
  • Type: java.lang.String
  • Required: No

buildOutputDirectory:

Location of the compiled classes.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}

extraJvmArgs:

Extra JVM arguments that are passed to the GWT-Maven generated scripts (for compiler, shell, etc - typically use -Xmx512m here, or -XstartOnFirstThread, etc).

Can be set from command line using '-Dgwt.extraJvmArgs=...', defaults to setting max Heap size to be large enough for most GWT use cases.

  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.extraJvmArgs}
  • Default: -Xmx512m

generateDirectory:

Folder where generated-source will be created (automatically added to compile classpath).
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/generated-sources/gwt

gwtHome:

Location on filesystem where GWT is installed - for manual mode (existing GWT on machine). Setting this parameter will disable gwtVersion.
  • Type: java.io.File
  • Required: No
  • Expression: ${google.webtoolkit.home}

gwtVersion:

GWT version used to build dependency paths, should match the "version" in the Maven repo. If not set, will be autodetected from project com.google.gwt:gwt-user dependency
  • Type: java.lang.String
  • Required: No

hostedWebapp:

Location of the hosted-mode web application structure. Default value matches the Google Eclipse plugin.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/war

inplace:

Select the place where GWT application is built. In inplace mode, the warSourceDirectory is used to match the same use case of the war plugin.
  • Type: boolean
  • Required: No
  • Expression: ${gwt.inplace}
  • Default: false

module:

A single GWT module. Shortcut for <modules> or option to specify a single module from command line
  • Type: java.lang.String
  • Required: No
  • Expression: ${gwt.module}

modules:

The project GWT modules. If not set, the plugin will scan the project for .gwt.xml files.
  • Type: java.lang.String[]
  • Required: No

noserver:

Run without hosted mode server
  • Type: boolean
  • Required: No
  • Expression: ${gwt.noserver}
  • Default: false

port:

Port of the HTTP server used when noserver is set
  • Type: int
  • Required: No
  • Expression: ${gwt.port}
  • Default: 8080

useGoogleEclispePlugin:

Setup a launch configuration for using the Google Eclipse Plugin. This is the recommended setup, as the home-made launch configuration has many limitations. This parameter is only for backward compatibility, the standard lauch configuration template will be removed in a future release.
  • Type: boolean
  • Required: No
  • Expression: ${use.google.eclipse.plugin}
  • Default: true

warSourceDirectory:

Location of the web application static resources (same as maven-war-plugin parameter)
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/webapp

webappDirectory:

Location on filesystem where GWT will write output files (-out option to GWTCompiler).
  • Type: java.io.File
  • Required: No
  • Expression: ${gwt.war}
  • Default: ${project.build.directory}/${project.build.finalName}