Removes all files from the output directory before running SchemaGenerator.

If true, Elements or Attributes in the generated XSD files will be annotated with any JavaDoc found for their respective properties. If false, no XML documentation annotations will be generated in post-processing any results from the JAXB SchemaGenerator.

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.

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 SchemaGen parameter: episode.

Generate an episode file from this XSD generation, 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.

A renderer used to create XML annotation text from JavaDoc comments found within the source code. Unless another implementation is provided, the standard JavaDocRenderer used is DefaultJavaDocRenderer.

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>
    

The directory where the generated XML Schema file(s) will be placed, after all transformations are done.

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

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

1. Find all files given in the sources List. Any Directories provided are searched for files recursively.
2. Exclude any found files matching any of the supplied schemaSourceExcludeFilters 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>
        ...
             <schemaSourceExcludeFilters>
                 <filter implementation="org.codehaus.mojo.jaxb2.shared.filters.pattern.PatternFileFilter">
                     <patterns>
                         <pattern>\.txt</pattern>
                         <pattern>\.foo</pattern>
                     </patterns>
                 </filter>
             </schemaSourceExcludeFilters>
        </configuration>
    

Note that inner workings of the Dependency Injection mechanism used by Maven Plugins (i.e. the DI from the Plexus container) requires that the full class name to the Filter implementation should be supplied for each filter, as is illustrated in the sample above. This is true also if you implement custom Filters.

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

 <configuration>
  ...
      <sources>
         <source>/a/full/absolute/path/to/a/SourceFile.java</source>
         <source>target/some/sourceJar.jar</source>
         <source>src/main/java</source>
     </sources>
  </configuration>

Note: if configured, the sources parameters replace the default value, which is a List containing the paths to the directories defined by getProject().getCompileSourceRoots().

A List holding desired schema mappings, each of which binds a schema namespace URI to its desired prefix [optional] and the name of the resulting schema file [optional]. All given elements (uri, prefix, file) must be unique within the configuration; no two elements may have the same values.

The example schema configuration below maps two namespace uris to prefixes and generated file names. This implies that http://some/namespace will be represented by the prefix some within the generated XML Schema files; creating namespace definitions on the form xmlns:some="http://some/namespace", and corresponding uses on the form <xs:element minOccurs="0" ref="some:anOptionalElementInSomeNamespace"/>. Moreover, the file element defines that the http://some/namespace definitions will be written to the file some_schema.xsd, and that all import references will be on the form <xs:import namespace="http://some/namespace" schemaLocation="some_schema.xsd"/>

The example configuration below also performs identical operations for the namespace uri http://another/namespace with the prefix another and the file another_schema.xsd.

    
<transformSchemas>
  <transformSchema>
    <uri>http://some/namespace</uri>
    <toPrefix>some</toPrefix>
    <toFile>some_schema.xsd</toFile>
  <transformSchema>
    <uri>http://another/namespace</uri>
    <toPrefix>another</toPrefix>
    <toFile>another_schema.xsd</toFile>
  </transformSchema>
</transformSchemas>
    

The directory where the schemagen tool will output XSDs, episode files - and intermediary bytecode files. From this directory the XSDs and the episode file (but not the bytecode files) will be copied to the outputDirectory for further processing.