JiBX - jibx:schema-codegen

maven-jibx-plugin

##### Main Project

- JiBX

##### Overview

- Introduction
- Goals
- Usage

##### Configuration

- Execution Modes

##### Examples

- Basic Binding Compilation
- Advanced Binding Compilation
- Generate Java Sources from Schemas
- Generate Modular Code from Schemas
- Test Case Usage
- XML Document comparison

## jibx:schema-codegen

Full name:

org.jibx:maven-jibx-plugin:1.2.3-SNAPSHOT:schema-codegen

Description:

Generates Java sources from XSD schemas.

Attributes:

- Requires a Maven 2.0 project to be executed.
- Requires dependency resolution of artifacts in scope: `compile`.
- Binds by default to the lifecycle phase: `generate-sources`.

### Required Parameters

Name | Type | Since | Description
--- | --- | --- | ---
directory | `String` | `-` | The directory which contains XSD files. Default value is: `${basedir}/src/main/config`.
verbose | `boolean` | `-` | Control flag for verbose processing reports. Default value is: `false`.

### Optional Parameters

Name | Type | Since | Description
--- | --- | --- | ---
customizations | `ArrayList` | `-` | Include pattern for customization files.
defaultNamespace | `String` | `-` | Namespace applied in code generation when no-namespaced schema definitions are found (to generate no-namespaced schemas as though they were included in a particular namespace)
defaultPackage | `String` | `-` | Default package for code generated from schema definitions with no namespace.
excludes | `ArrayList` | `-` | Exclude pattern for binding files.
includeBindings | `ArrayList` | `-` | 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: <includeBindings> <includeBinding>base-binding.xml</includeBinding> </includeBindings> Note: Relative paths start at ${basedir}.
includes | `ArrayList` | `-` | Include pattern for schema files. Note: Uses the standard filter format described in the plexus DirectoryScanner. Defaults value is: *.xsd.
options | `Map` | `-` | Extra options to be given for customization via CLI. Enter extra customizations or other command-line options. The extra customizations are described on the CodeGen customizations page The single character CodeGen commands may also be supplied here. For example, to include a base binding file (-i) and prefer-inline code, supply the following options: `<options> <i>base-binding.xml</i> <prefer-inline>true</prefer-inline> </options>`
targetDirectory | `String` | `-` | Target directory where to generate Java source files. Default value is: `${basedir}/target/generated-sources`.

### Parameter Details

customizations:

Include pattern for customization files.

- Type: `java.util.ArrayList`
- Required: `No`
- Expression: `${customizations}`

defaultNamespace:

Namespace applied in code generation when no-namespaced schema definitions are found (to generate no-namespaced schemas as though they were included in a particular namespace)

- Type: `java.lang.String`
- Required: `No`

defaultPackage:

Default package for code generated from schema definitions with no namespace.

- Type: `java.lang.String`
- Required: `No`

directory:

The directory which contains XSD files.

- Type: `java.lang.String`
- Required: `Yes`
- Expression: `${directory}`
- Default: `${basedir}/src/main/config`

excludes:

Exclude pattern for binding files.

- Type: `java.util.ArrayList`
- Required: `No`
- Expression: `${excludes}`

includeBindings:

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:
<includeBindings>
<includeBinding>base-binding.xml</includeBinding>
</includeBindings>
Note: Relative paths start at ${basedir}.

- Type: `java.util.ArrayList`
- Required: `No`
- Expression: `${includeBindings}`

includes:

Include pattern for schema files.
Note: Uses the standard filter format described in the plexus DirectoryScanner.
Defaults value is: *.xsd.

- Type: `java.util.ArrayList`
- Required: `No`
- Expression: `${includes}`

options:

Extra options to be given for customization via CLI.

Enter extra customizations or other command-line options.
The extra customizations are described on the CodeGen customizations page
The single character CodeGen commands may also be supplied here.
For example, to include a base binding file (-i) and prefer-inline code, supply the following options:
`<options>
<i>base-binding.xml</i>
<prefer-inline>true</prefer-inline>
</options>`

- Type: `java.util.Map`
- Required: `No`

targetDirectory:

Target directory where to generate Java source files.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${targetDirectory}`
- Default: `${basedir}/target/generated-sources`

verbose:

Control flag for verbose processing reports.

- Type: `boolean`
- Required: `Yes`
- Expression: `${verbose}`
- Default: `false`