osxappbundle:bundle

Full name:

org.codehaus.mojo:osxappbundle-maven-plugin:1.0-alpha-2:bundle

Description:

Package dependencies as an Application Bundle for Mac OS X.

Attributes:

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

Required Parameters

Name Type Since Description
bundleName String - The name of the Bundle. This is the name that is given to the application bundle; and it is also what will show up in the application menu, dock etc. Default value is: ${project.name}.
mainClass String - The main class to execute when double-clicking the Application Bundle

Optional Parameters

Name Type Since Description
additionalClasspath List - Paths to be put on the classpath in addition to the projects dependencies. Might be useful to specifiy locations of dependencies in the provided scope that are not distributed with the bundle but have a known location on the system. http://jira.codehaus.org/browse/MOJO-874
additionalResources List - Additional resources (as a list of FileSet objects) that will be copies into the build directory and included in the .dmg and zip files alongside with the application bundle.
buildDirectory File - The directory where the application bundle will be created Default value is: ${project.build.directory}/${project.build.finalName}.
dictionaryFile String - The location of the template for Info.plist. Classpath is checked before the file system. Default value is: org/codehaus/mojo/osxappbundle/Info.plist.template.
diskImageFile File - The location of the generated disk image file Default value is: ${project.build.directory}/${project.build.finalName}.dmg.
iconFile File - The icon file for the bundle
internetEnable boolean - If this is set to true, the generated DMG file will be internet-enabled. The default is ${false} Default value is: false.
javaApplicationStub File - The location of the Java Application Stub Default value is: /System/Library/Frameworks/JavaVM.framework/Versions/Current/Resources/MacOS/JavaApplicationStub.
jvmVersion String - A value for the JVMVersion key. Default value is: 1.4+.
version String - The version of the project. Will be used as the value of the CFBundleVersion key. Default value is: ${project.version}.
vmOptions String - Options to the JVM, will be used as the value of VMOptions in Info.plist.
zipFile File - The location of the produced Zip file containing the bundle. Default value is: ${project.build.directory}/${project.build.finalName}-app.zip.

Parameter Details

additionalClasspath :

Paths to be put on the classpath in addition to the projects dependencies. Might be useful to specifiy locations of dependencies in the provided scope that are not distributed with the bundle but have a known location on the system. http://jira.codehaus.org/browse/MOJO-874

  • Type: java.util.List
  • Required: No

additionalResources :

Additional resources (as a list of FileSet objects) that will be copies into the build directory and included in the .dmg and zip files alongside with the application bundle.

  • Type: java.util.List
  • Required: No

buildDirectory :

The directory where the application bundle will be created

  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}

bundleName :

The name of the Bundle. This is the name that is given to the application bundle; and it is also what will show up in the application menu, dock etc.

  • Type: java.lang.String
  • Required: Yes
  • Default: ${project.name}

dictionaryFile :

The location of the template for Info.plist. Classpath is checked before the file system.

  • Type: java.lang.String
  • Required: No
  • Default: org/codehaus/mojo/osxappbundle/Info.plist.template

diskImageFile :

The location of the generated disk image file

  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}.dmg

iconFile :

The icon file for the bundle

  • Type: java.io.File
  • Required: No

internetEnable :

If this is set to true, the generated DMG file will be internet-enabled. The default is ${false}

  • Type: boolean
  • Required: No
  • Default: false

javaApplicationStub :

The location of the Java Application Stub

  • Type: java.io.File
  • Required: No
  • Default: /System/Library/Frameworks/JavaVM.framework/Versions/Current/Resources/MacOS/JavaApplicationStub

jvmVersion :

A value for the JVMVersion key.

  • Type: java.lang.String
  • Required: No
  • Default: 1.4+

mainClass :

The main class to execute when double-clicking the Application Bundle

  • Type: java.lang.String
  • Required: Yes
  • Expression: ${mainClass}

version :

The version of the project. Will be used as the value of the CFBundleVersion key.

  • Type: java.lang.String
  • Required: No
  • Default: ${project.version}

vmOptions :

Options to the JVM, will be used as the value of VMOptions in Info.plist.

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

zipFile :

The location of the produced Zip file containing the bundle.

  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}-app.zip