jibx:bind

Full name:

org.jibx:maven-jibx-plugin:1.3.1:bind

Description:

Runs the JiBX binding compiler.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
load boolean - Control flag for test loading generated/modified classes.
Default value is: false.
User property is: load.
multimodule boolean - Control flag multi-module mode.
Default value is: false.
User property is: multi-module.
validate boolean - Control flag for test loading generated/modified classes.
Default value is: true.
User property is: validate.
verbose boolean - Control flag for verbose processing reports.
Default value is: false.
User property is: verbose.
verify boolean - Control flag for verifying generated/modified classes with BCEL.
Default value is: false.
User property is: verify.

Optional Parameters

Name Type Since Description
baseBindingDirectory String - Get the default location of the base binding files.
Defaults value is: schemaBindingDirectory.
User property is: baseBindingDirectory.
directory String - Deprecated. - Since binding and codegen use this for different locations, use schemaBindingDirectory.
Defaults to "src/main/config" (or "src/test/config" for test goals).
User property is: directory.
excludeSchemaBindings ArrayList - Exclude pattern for schema binding files.
User property is: excludeSchemaBindings.
excludes ArrayList - Deprecated. - This name was confusing since it is used as a binding file pattern for bind and a schema file pattern for code-gen.
Use excludeSchemaBindings for binding and excludeSchemas for schema
User property is: excludes.
includeBaseBindings HashSet - A list of modules or files to search for base binding files. This can specify files in the local directory or files stored in your dependencies. If your based binding files are in a local file system, specify them as follows:
<includeBaseBindings>
  <includeBaseBinding>
    <directory>src/main/config</directory>
    <includes>
      <include>base-binding.xml</include>
    </includes>
  </includeBaseBinding>
 </includeBaseBindings>
If your based binding files are in a artifact that is one of your dependencies:
<includeBaseBindings>
  <includeBaseBinding>
    <groupId>com.mycompany.baseschema</groupId>
    <artifactId>base-schema</artifactId>
    <classifier>bindings</classifier>
    <directory>META-INF</directory>
    <includes>
      <include>base-binding.xml</include>
    </includes>
  </includeBaseBinding>
</includeBaseBindings>
The classifier is optional (if your binding file is not in the main artifact) A version is not necessary, since this declaration must be on your list of dependencies.
Note: For file filters, use the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml. Include existing bindings and use mappings from the bindings for matching schema global definitions. (this is the basis for modular code generation)
Note: If directory is not specified, relative paths start at <baseBindingDirectory>.
User property is: includeBaseBindings.
includeSchemaBindings ArrayList - Include pattern for schema binding files.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml. Include existing bindings and use mappings from the bindings for matching schema global definitions. (this is the basis for modular code generation) Include base bindings as follows:
<includeSchemaBindings>
  <includeSchemaBinding>base-binding.xml</includeSchemaBinding>
</includeSchemaBindings>
Note: Relative paths start at <directory>.
User property is: includeSchemaBindings.
includes ArrayList - Deprecated. - This name was confusing since it is used as a binding file pattern for bind and a schema file pattern for code-gen.
Use includeSchemaBindings for binding and includeSchemas for schema.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml.
User property is: includes.
modules HashSet - A list of modules to search for binding files in the format: groupID:artifactID
User property is: modules.
schemaBindingDirectory String - The directory which contains schema binding files. Defaults to "src/main/config" (or "src/test/config" for test goals). For code-gen or if the default directory does not exist, defaults to "target/generated-sources" (or "target/generated-test-sources" for test goals).
User property is: schemaBindingDirectory.

Parameter Details

baseBindingDirectory:

Get the default location of the base binding files.
Defaults value is: schemaBindingDirectory.
  • Type: java.lang.String
  • Required: No
  • User Property: baseBindingDirectory

directory:

Deprecated. - Since binding and codegen use this for different locations, use schemaBindingDirectory.
Defaults to "src/main/config" (or "src/test/config" for test goals).
The directory which contains binding files.
  • Type: java.lang.String
  • Required: No
  • User Property: directory

excludeSchemaBindings:

Exclude pattern for schema binding files.
  • Type: java.util.ArrayList
  • Required: No
  • User Property: excludeSchemaBindings

excludes:

Deprecated. - This name was confusing since it is used as a binding file pattern for bind and a schema file pattern for code-gen.
Use excludeSchemaBindings for binding and excludeSchemas for schema
Exclude pattern for binding files.
  • Type: java.util.ArrayList
  • Required: No
  • User Property: excludes

includeBaseBindings:

A list of modules or files to search for base binding files. This can specify files in the local directory or files stored in your dependencies. If your based binding files are in a local file system, specify them as follows:
<includeBaseBindings>
  <includeBaseBinding>
    <directory>src/main/config</directory>
    <includes>
      <include>base-binding.xml</include>
    </includes>
  </includeBaseBinding>
 </includeBaseBindings>
If your based binding files are in a artifact that is one of your dependencies:
<includeBaseBindings>
  <includeBaseBinding>
    <groupId>com.mycompany.baseschema</groupId>
    <artifactId>base-schema</artifactId>
    <classifier>bindings</classifier>
    <directory>META-INF</directory>
    <includes>
      <include>base-binding.xml</include>
    </includes>
  </includeBaseBinding>
</includeBaseBindings>
The classifier is optional (if your binding file is not in the main artifact) A version is not necessary, since this declaration must be on your list of dependencies.
Note: For file filters, use the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml. Include existing bindings and use mappings from the bindings for matching schema global definitions. (this is the basis for modular code generation)
Note: If directory is not specified, relative paths start at <baseBindingDirectory>.
  • Type: java.util.HashSet
  • Required: No
  • User Property: includeBaseBindings

includeSchemaBindings:

Include pattern for schema binding files.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml. Include existing bindings and use mappings from the bindings for matching schema global definitions. (this is the basis for modular code generation) Include base bindings as follows:
<includeSchemaBindings>
  <includeSchemaBinding>base-binding.xml</includeSchemaBinding>
</includeSchemaBindings>
Note: Relative paths start at <directory>.
  • Type: java.util.ArrayList
  • Required: No
  • User Property: includeSchemaBindings

includes:

Deprecated. - This name was confusing since it is used as a binding file pattern for bind and a schema file pattern for code-gen.
Use includeSchemaBindings for binding and includeSchemas for schema.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: binding.xml.
Include pattern for binding files.
  • Type: java.util.ArrayList
  • Required: No
  • User Property: includes

load:

Control flag for test loading generated/modified classes.
  • Type: boolean
  • Required: Yes
  • User Property: load
  • Default: false

modules:

A list of modules to search for binding files in the format: groupID:artifactID
  • Type: java.util.HashSet
  • Required: No
  • User Property: modules

multimodule:

Control flag multi-module mode.
  • Type: boolean
  • Required: Yes
  • User Property: multi-module
  • Default: false

schemaBindingDirectory:

The directory which contains schema binding files. Defaults to "src/main/config" (or "src/test/config" for test goals). For code-gen or if the default directory does not exist, defaults to "target/generated-sources" (or "target/generated-test-sources" for test goals).
  • Type: java.lang.String
  • Required: No
  • User Property: schemaBindingDirectory

validate:

Control flag for test loading generated/modified classes.
  • Type: boolean
  • Required: Yes
  • User Property: validate
  • Default: true

verbose:

Control flag for verbose processing reports.
  • Type: boolean
  • Required: Yes
  • User Property: verbose
  • Default: false

verify:

Control flag for verifying generated/modified classes with BCEL.
  • Type: boolean
  • Required: Yes
  • User Property: verify
  • Default: false