Corresponding XJC parameter: mark-generated.

This feature causes all of the generated code to have @Generated annotation.

List of ordered extra arguments to the XJC command. Each extra argument is interpreted as a word, intended to be copied verbatim to the XJC argument list with spaces in between:

 <configuration>
  ...
      <arguments>
         <argument>-Xfluent-api</argument>
         <argument>somefile</argument>
     </arguments>
  </configuration>

The arguments configured above yields the following extra arguments to the XJC command: -Xfluent-api -episode somefile

Corresponding XJC parameter: catalog.

Specify catalog files to resolve external entity references. Supports TR9401, XCatalog, and OASIS XML Catalog format.

Removes all files from the output directory before running XJC.

Corresponding XJC parameter: enableIntrospection.

Enable correct generation of Boolean getters/setters to enable Bean Introspection APIs.

Defines the encoding used by XJC (for generating Java Source files) and schemagen (for generating XSDs). The corresponding argument parameter for XJC and SchemaGen is: encoding.

The algorithm for finding the encoding to use is as follows (where the first non-null value found is used for encoding):

1. If the configuration property is explicitly given within the plugin's configuration, use that value.
2. If the Maven property project.build.sourceEncoding is defined, use its value.
3. Otherwise use the value from the system property file.encoding.

Corresponding XJC parameter: extension.

By default, the XJC binding compiler strictly enforces the rules outlined in the Compatibility chapter of the JAXB Specification. Appendix E.2 defines a set of W3C XML Schema features that are not completely supported by JAXB v1.0. In some cases, you may be allowed to use them in the "-extension" mode enabled by this switch. In the default (strict) mode, you are also limited to using only the binding customizations defined in the specification.

Defines a set of extra EnvironmentFacet instances which are used to further configure the ToolExecutionEnvironment used by this plugin to fire XJC or SchemaGen.

Example: If you implement the EnvironmentFacet interface in the class org.acme.MyCoolEnvironmentFacetImplementation, its setup() method is called before the XJC or SchemaGen tools are executed to setup some facet of their Execution environment. Correspondingly, the restore() method in your org.acme.MyCoolEnvironmentFacetImplementation class is invoked after the XJC or SchemaGen execution terminates.

    
       <configuration>
        ...
             <extraFacets>
                 <extraFacet implementation="org.acme.MyCoolEnvironmentFacetImplementation" />
             </extraFacets>
        ...
        </configuration>
    

Corresponding XJC parameter: episode.

Generate an episode file from this compilation, so that other schemas that rely on this schema can be compiled later and rely on classes that are generated from this compilation. The generated episode file is really just a JAXB customization file (but with vendor extensions.)

If this parameter is true, the episode file generated is called META-INF/sun-jaxb.episode, and included in the artifact.

Corresponding XJC parameter: nv.

By default, the XJC binding compiler performs strict validation of the source schema before processing it. Use this option to disable strict schema validation. This does not mean that the binding compiler will not perform any validation, it simply means that it will perform less-strict validation.

A Locale definition to create and set the system (default) Locale when the XJB or SchemaGen tools executes. The Locale will be reset to its default value after the execution of XJC or SchemaGen is complete.

The configuration parameter must be supplied on the form language[,country[,variant]], such as sv,SE or fr. Refer to org.codehaus.mojo.jaxb2.shared.environment.locale.LocaleFacet.createFor(String, Log) for further information.

Example (assigns french locale):

    
       <configuration>
             <locale>fr</locale>
        </configuration>
    

Corresponding XJC parameter: no-header.

Suppress the generation of a file header comment that includes some note and timestamp. Using this makes the generated code more diff-friendly.

Corresponding XJC parameter: npa.

Suppress the generation of package level annotations into package-info.java. Using this switch causes the generated code to internalize those annotations into the other generated classes.

Corresponding XJC parameter: d.

The working directory where the generated Java test source files are created.

Corresponding XJC parameter: p.

The package under which the source files will be generated. Quoting the XJC documentation: "Specifying a target package via this command-line option overrides any binding customization for package name and the default package name algorithm defined in the specification".

Corresponding XJC parameter: quiet.

Suppress compiler output, such as progress information and warnings.

Corresponding XJC parameter: readOnly.

By default, the XJC binding compiler does not write-protect the Java source files it generates. Use this option to force the XJC binding compiler to mark the generated Java sources read-only.

Defines the content type of sources for the XJC. To simplify usage of the JAXB2 maven plugin, all source files are assumed to have the same type of content.

This parameter replaces the previous multiple-choice boolean configuration options for the jaxb2-maven-plugin (i.e. dtd, xmlschema, relaxng, relaxng-compact, wsdl), and corresponds to setting one of those flags as an XJC argument.

Corresponding XJC parameter: target.

Permitted values: "2.0" and "2.1". Avoid generating code that relies on JAXB newer than the version given. This will allow the generated code to run with JAXB 2.0 runtime (such as JavaSE 6.)

Parameter holding a List of Filters, used to match all files under the testSources directories which should not be considered XJC test source files. (The filters identify files to exclude, and hence this parameter is called testS§ourceExcludeFilters). If a file under any of the test source directories matches at least one of the Filters supplied in the testSourceExcludeFilters, it is not considered an XJC source file, and therefore excluded from processing.

If not explicitly provided, the Mojo uses the value within STANDARD_TEST_SOURCE_EXCLUDE_FILTERS. The algorithm for finding XJC test sources is as follows:

1. Find all files given in the testSources List. Any Directories provided are searched for files recursively.
2. Exclude any found files matching any of the supplied testSourceExcludeFilters List.
3. The remaining Files are submitted for processing by the XJC tool.

Example: The following configuration would exclude any sources whose names end with txt or foo:

    
       <configuration>
        ...
             <testSourceExcludeFilters>
                 <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">txt</suffixFilter>
                 <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">foo</suffixFilter>
             </testSourceExcludeFilters>
        </configuration>
    

Parameter holding List of XSD paths to files and/or directories which should be recursively searched for XSD files. Only files or directories that actually exist will be included (in the case of files) or recursively searched for XSD files to include (in the case of directories). Configure using standard Maven structure for Lists:

 <configuration>
  ...
      <testSources>
         <testSource>some/explicit/relative/file.xsd</testSource>
         <testSource>/another/absolute/path/to/a/specification.xsd</testSource>
         <testSource>a/directory/holding/xsds</testSource>
     </testSources>
  </configuration>

Parameter holding a List of Filters, used to match all files under the testXjbSources directories which should not be considered XJB files. (The filters identify files to exclude, and hence this parameter is called testXjbExcludeFilters). If a file matches at least one of the supplied Filters, it is not considered an XJB file, and therefore excluded from processing.

If not explicitly provided, the Mojo uses the value within STANDARD_TEST_XJB_EXCLUDE_FILTERS.

Example: The following configuration would exclude any XJB files whose names end with xml or foo:

    
       <configuration>
        ...
             <testXjbExcludeFilters>
                 <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">xml</suffixFilter>
                 <suffixFilter impl="org.codehaus.mojo.jaxb2.shared.filters.source.ExclusionRegularExpressionFileFilter">foo</suffixFilter>
             </sourceExcludeFilters>
        </testXjbExcludeFilters>
    

Parameter holding List of XJB Files and/or directories which should be recursively searched for XJB files. Only files or directories that actually exist will be included (in the case of files) or recursively searched for XJB files to include (in the case of directories). JAXB binding files are used to configure parts of the Java source generation. Supply the configuration using the standard Maven structure for configuring plugin Lists:

 <configuration>
  ...
      <testXjbSources>
         <testXjbSource>bindings/aBindingConfiguration.xjb</testXjbSource>
         <testXjbSource>bindings/config/directory</testXjbSource>
     </testXjbSources>
  </configuration>

Corresponding XJC parameter: verbose.

Tells XJC to be extra verbose, such as printing informational messages or displaying stack traces.

If provided, this parameter indicates that the XSDs used by XJC to generate Java code should be copied into the resulting artifact of this project (the JAR, WAR or whichever artifact type is generated). The value of the xsdPathWithinArtifact parameter is the relative path within the artifact where all source XSDs are copied to (hence the name "XSD Path Within Artifact").

The target directory is created within the artifact if it does not already exist. If the xsdPathWithinArtifact parameter is not given, the XSDs used to generate Java code are not included within the project's artifact.

Example:Adding the sample configuration below would copy all source XSDs to the given directory within the resulting JAR (and/or test-JAR). If the directory META-INF/jaxb/xsd does not exist, it will be created.

    
       <configuration>
            ...
            <xsdPathWithinArtifact>META-INF/jaxb/xsd</xsdPathWithinArtifact>
        </configuration>
    

Note: This parameter was previously called includeSchemasOutputPath in the 1.x versions of this plugin, but was renamed and re-documented for improved usability and clarity.