jour:generate

The jour:generate will create API stub classes.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Automatically executes within the lifecycle phase: compile

Required Parameters

Name Type Description
output File The directory containing project classes.
signature File The API descriptor XML.

Optional Parameters

Name Type Description
classVersion String Java platform version for created classes. e.g. 1.1, 1.3, 1.4, 1.5 or 1.6
level String Export API level public|[protected]|package|private
packages String Export Only selected packages
stubException String API stub empty method/constructor body code may just throw Exception class name can be selected.
stubExceptionMessage String Exception class constructor String argument
useSystemClassPath boolean Appends the system search path to the end of the search path. The system search path usually includes the platform library, extension libraries, and the search path specified by the -classpath option or the CLASSPATH environment variable.

Parameter Details

classVersion

Java platform version for created classes. e.g. 1.1, 1.3, 1.4, 1.5 or 1.6

  • Type: java.lang.String
  • Required: No
level Export API level public|[protected]|package|private
  • Type: java.lang.String
  • Required: No
  • Expression: protected
output The directory containing project classes.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}
packages Export Only selected packages
  • Type: java.lang.String
  • Required: No
signature The API descriptor XML.
  • Type: java.io.File
  • Required: Yes
stubException API stub empty method/constructor body code may just throw Exception class name can be selected.
  • Type: java.lang.String
  • Required: No
stubExceptionMessage Exception class constructor String argument
  • Type: java.lang.String
  • Required: No
useSystemClassPath Appends the system search path to the end of the search path. The system search path usually includes the platform library, extension libraries, and the search path specified by the -classpath option or the CLASSPATH environment variable.
  • Type: boolean
  • Required: No
  • Expression: false