-
Notifications
You must be signed in to change notification settings - Fork 103
Configuration Cheat Sheet
highsource edited this page Oct 21, 2014
·
13 revisions
Work in progress
<configuration>
<!-- # Specifying what to compile # -->
<!-- ## Specifying schemas ## -->
<!-- ### Basic usage, from directory ## -->
<!-- Specifies the schema directory, src/main/resources by default -->
<schemaDirectory>src/main/resources</schemaDirectory>
<!-- Specifies file patterns to include as schemas. By default all *.xsd files will be included. -->
<schemaIncludes>
<include>**/*.xsd</include>
</schemaIncludes>
<!-- Specifies file patterns of schemas to exclude. By default, nothing is excluded. -->
<schemaExcludes>
<include>**/*.xs</include>
</schemaExcludes>
<!-- ### Extended usage ### -->
<!-- Specifies schemas as filesets, URLs or Maven artifact resources. -->
<schemas>
<schema>
<!-- Specifies a schema from the Maven artifact. -->
<dependencyResource>
<!-- Group id of the artifact, required. -->
<groupId>org.jvnet.jaxb2.maven2</groupId>
<!-- Artifact id of the artifact, required. -->
<artifactId>maven-jaxb2-plugin-tests-po</artifactId>
<!-- Version of the artifact. May be omitted.
The plugin will then try to find the version using
the dependencyManagement and dependencies of the project. -->
<version>${project.version}</version>
<!-- Path of the resource within the artifact. -->
<resource>purchaseorder.xsd</resource>
</dependencyResource>
</schema>
<schema>
<!-- Specifies a schema URL to compile. -->
<url>http://schemas.opengis.net/wms/1.3.0/exceptions_1_3_0.xsd</url>
</schema>
<schema>
<!-- Specifies a schema in the Maven artifact. -->
<url>maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-po:${project.version}!/po.xsd</url>
</schema>
<schema>
<!-- Specifies a fileset to compile. -->
<fileset>
<!-- Base directory of the fileset. Optional, defaults to schemaDirectory. -->
<directory>${basedir}/src/main/schemas</directory>
<!-- File patterns to include. Optional, defaults to schemaIncludes. -->
<includes>
<include>*.*</include>
</includes>
<!-- File patterns to exclude. Optional, defaults to schemaIncludes -->
<excludes>
<exclude>*.xs</exclude>
</excludes>
</fileset>
</schema>
</schemas>
<!-- Type of input schema language.
DTD, XMLSCHEMA, RELAXNG, RELAXNG_COMPACT, WSDL, AUTODETECT (defult). -->
<schemaLanguage>AUTODETECT</schemaLanguage>
<!-- ## Specifying bindings ## -->
<!-- ### Basic usage, from directory ## -->
<!-- Specifies the binding directory, default to the schemaDirectory -->
<bindingDirectory>src/main/resources</bindingDirectory>
<!-- Specifies file patterns to include as bindings. By default all *.xjb files will be included. -->
<bindingIncludes>
<include>**/*.xjb</include>
</bindingIncludes>
<!-- Specifies file patterns of bindings to exclude. By default, nothing is excluded. -->
<bindingExcludes>
<include>**/*.xj</include>
</bindingExcludes>
<!-- ### Extended usage ### -->
<!-- Specifies bindings as filesets, URLs or Maven artifact resources. -->
<bindings>
<binding>
<!-- Specifies a binding from the Maven artifact. -->
<dependencyResource>
<!-- Group id of the artifact, required. -->
<groupId>org.jvnet.jaxb2.maven2</groupId>
<!-- Artifact id of the artifact, required. -->
<artifactId>maven-jaxb2-plugin-tests-po</artifactId>
<!-- Version of the artifact. May be omitted.
The plugin will then try to find the version using
the dependencyManagement and dependencies of the project. -->
<version>${project.version}</version>
<!-- Path of the resource within the artifact. -->
<resource>bindings.xjb</resource>
</dependencyResource>
</binding>
<binding>
<!-- Specifies an URL of the binding to use. -->
<url>http://schemas.opengis.net/wms/1.3.0/binding.xjb</url>
</binding>
<schema>
<!-- Specifies a binding in the Maven artifact. -->
<url>maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-po:${project.version}!/bindings.xjb</url>
</schema>
<binding>
<!-- Specifies a fileset of bindings to use. -->
<fileset>
<!-- Base directory of the fileset. Optional, defaults to bindingDirectory. -->
<directory>${basedir}/src/main/bindings</directory>
<!-- File patterns to include. Optional, defaults to bindingIncludes. -->
<includes>
<include>*.xjb</include>
</includes>
<!-- File patterns to exclude. Optional, defaults to bindingExcludes. -->
<excludes>
<exclude>*.xj</exclude>
</excludes>
</fileset>
</binding>
</bindings>
<!-- # Using catalogs # -->
<!-- Specify the catalog file to resolve external entity references. -->
<catalog>src/main/resources/catalog.cat</catalog>
<!-- Specifies catalogs as filesets, URLs or Maven artifact resources. -->
<catalogs>
<catalog>
<!-- Specifies a catalog from the Maven artifact. -->
<dependencyResource>
<!-- Group id of the artifact, required. -->
<groupId>org.jvnet.jaxb2.maven2</groupId>
<!-- Artifact id of the artifact, required. -->
<artifactId>maven-jaxb2-plugin-tests-po</artifactId>
<!-- Version of the artifact. May be omitted.
The plugin will then try to find the version using
the dependencyManagement and dependencies of the project. -->
<version>${project.version}</version>
<!-- Path of the resource within the artifact. -->
<resource>catalog.cat</resource>
</dependencyResource>
</catalog>
<catalog>
<!-- Specifies an URL of the catalog to use. -->
<url>http://schemas.opengis.net/catalog.cat</url>
</catalog>
<catalog>
<!-- Specifies a catalog in the Maven artifact. -->
<url>maven:org.jvnet.jaxb2.maven2:maven-jaxb2-plugin-tests-po:${project.version}!/catalog.cat</url>
</catalog>
<catalog>
<!-- Specifies a fileset of the catalogs to use. -->
<fileset>
<!-- Base directory of the fileset. Optional, defaults to schemaDirectory. -->
<directory>${basedir}/src/main/catalogs</directory>
<!-- File patterns to include. Optional, defaults to *.cat. -->
<includes>
<include>*.cat</include>
</includes>
<!-- File patterns to exclude. Optional, by default nothing is excluded. -->
<excludes>
<exclude>*.ct</exclude>
</excludes>
</fileset>
</catalog>
</catalogs>
<!-- # Using episodes # -->
<!-- If true (default), the episode file (describing mapping of elements and types
to classes for the compiled schema) will be generated. -->
<episode>true</episode>
<!-- Target location of the episode file. By default it is ${generateDirectory}/META-INF/sun-jaxb.episode -->
<episodeFile>target/generated-sources/xjc/META-INF/sun-jaxb.episode</episodeFile>
<!-- Use all of the compile-scope project dependencies as episode artifacts. -->
<useDependenciesAsEpisodes>true</useDependenciesAsEpisodes>
<!-- Episodes -->
<episodes>
<episode>
<groupId>org.jvnet.jaxb2.maven2</groupId>
<artifactId>maven-jaxb2-plugin-tests-po</artifactId>
<!-- Version of the artifact. May be omitted.
The plugin will then try to find the version using
the dependencyManagement and dependencies of the project. -->
<version>${project.version}</version>
</episode>
</episodes>
</configuration>- Home
- Migration guide
-
JAXB Maven Plugin
- Quick Start
-
User Guide
- Basic Usage
- Specifying What To Compile
- Referencing Resources in Maven Artifacts
- Using Catalogs
- Using Episodes
- Modular Schema Compilation
- Controlling the Output
- Using JAXB Plugins
- Using a Specific JAXB Version
- Configuring Extension, Validation and XML Security
- IDE Integration
- Miscellaneous
- Configuring Proxies
- Maven Documentation
- Configuration Cheat Sheet
- Common Pitfalls and Problems
-
JAXB2 Basics Plugins
- Using JAXB2 Basics Plugins
- JSR-305 Support
-
JAXB2 Basics Plugins List
- SimpleEquals Plugin
- SimpleHashCode Plugin
- Equals Plugin
- HashCode Plugin
- ToString Plugin
- Copyable Plugin
- Mergeable Plugin
- Inheritance Plugin
- AutoInheritance Plugin
- Wildcard Plugin
- Setters Plugin
- Simplify Plugin
- EnumValue Plugin
- JAXBIndex Plugin
- FixJAXB1058 Plugin
- Commons Lang Plugin
- Default Value Plugin
- Fluent API Plugin
- Namespace Prefix Plugin
- Value Constructor Plugin
- Boolean Getter Plugin
- CamelCase Plugin
- XML ElementWrapper Plugin
- Parent Pointer Plugin
- Property Listener Injector Plugin
- Annox
- JAXB Annotate Plugin
-
HyperJAXB3
- Build System Support
- Customization Guide
- Databases
- Development guide
- Extension guide
- FAQ
- IDE Support
- Java Persistence
- JAXB
- JDK Support
- Project Templates
-
Reference
- Adding vendor-specific annotations
- Features
- Integrating Hyperjaxb3 in builds
- Introduction
- Making schema-derived classes ready for JPA
- Adding required properties
- Applying workarounds for JAXB vs. JPA conflicts
- Enforcing top-level classes
- Generating equals and hashCode methods
- Generating ORM metadata
- Generating persistence unit descriptor
- JPA 2 Support
- Making classes serializable
- Testing generated mappings
- Reference - single page
- Related Projects
- Sample projects
- Solutions
- Target Scenarios
- Test Projects
- Tutorials
- Best Practices
- FAQ
- Sample Projects
- Support
- License
- Distribution