jarchive:generate-template

Full name:

net.sourceforge.jarchive:maven-jarchive-plugin:1.0-SNAPSHOT:generate-template

Description:

This will generate the classes and other resources for an archive implementation.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
archiveDescription String - The description of the archive.
archiveName String - The name of the archive.
author String - The author that will be used in the generated code.
defaultExtension String - De most common extension of the archive
defaultMimetype String - The default mime type of the archive.
generatedResourcesBaseDir File - The directory where the generated HelpMojo file will be put.
generatedSourcesBaseDir File - The directory where the generated java files will be put.
platform String - The default platform where the archive exists.

Optional Parameters

Name Type Since Description
binairyContentDescriptorFile File - The location of the text for describing the contents. If this is not used the plugin will try to look in it's on repository to find a match.
driverPackage String - The package where the driver classes will be generated in. Default value is: ${project.groupId}.${project.artifactId}.
driverVersion String - The version for the driver.xml must be mayor.minor syntact using numbers Default value is: 1.0.
entryProperties Properties - entry Properties.
failOnError boolean - Must the plug in fail on error. Default value is: true.
generatedReportBaseDir File - The base directory where the reports will be generated in by the build plugins.
resourceBaseDir File - The relative path from the basedir to the place where the resources will be placed in. Default value is: src/main/resources.
sourceBaseDir File - The relative path from the basedir to the place where the sources will placed in. Default value is: src/main/java.
version String - The starting version. Default value is: ${project.version}.

Parameter Details

archiveDescription :

The description of the archive.

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

archiveName :

The name of the archive.

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

author :

The author that will be used in the generated code.

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

binairyContentDescriptorFile :

The location of the text for describing the contents. If this is not used the plugin will try to look in it's on repository to find a match.

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

defaultExtension :

De most common extension of the archive

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

defaultMimetype :

The default mime type of the archive.

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

driverPackage :

The package where the driver classes will be generated in.

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

driverVersion :

The version for the driver.xml must be mayor.minor syntact using numbers

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

entryProperties :

entry Properties.

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

failOnError :

Must the plug in fail on error.

  • Type: boolean
  • Required: No
  • Default: true

generatedReportBaseDir :

The base directory where the reports will be generated in by the build plugins.

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

generatedResourcesBaseDir :

The directory where the generated HelpMojo file will be put.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-resources/jarchive

generatedSourcesBaseDir :

The directory where the generated java files will be put.

  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-sources/jarchive

platform :

The default platform where the archive exists.

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

resourceBaseDir :

The relative path from the basedir to the place where the resources will be placed in.

  • Type: java.io.File
  • Required: No
  • Default: src/main/resources

sourceBaseDir :

The relative path from the basedir to the place where the sources will placed in.

  • Type: java.io.File
  • Required: No
  • Default: src/main/java

version :

The starting version.

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