jour:signatureVerify

The jour:signatureVerify will compare API descriptor and API classes.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: compile
  • Automatically executes within the lifecycle phase: test

Required Parameters

Name Type Description
classes File The directory or jar containing API classes.
signature File The API descriptor XML.

Optional Parameters

Name Type Description
allowAPIextension boolean Generate error if new API member with access level public or protected has been added to class.
allowThrowsLess boolean Generate error if new API member throw less exception than declared in API
level String Compare API level public|[protected]|package|private
packages String Compare Only selected packages
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

allowAPIextension Generate error if new API member with access level public or protected has been added to class.
  • Type: boolean
  • Required: No
  • Expression: true
allowThrowsLess Generate error if new API member throw less exception than declared in API
  • Type: boolean
  • Required: No
  • Expression: true
classes The directory or jar containing API classes.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}
level Compare API level public|[protected]|package|private
  • Type: java.lang.String
  • Required: No
  • Expression: protected
packages Compare Only selected packages
  • Type: java.lang.String
  • Required: No
signature The API descriptor XML.
  • Type: java.io.File
  • Required: Yes
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: true