xmlbeans:xmlbeans

A Maven 2 plugin which parses xsd files and produces a corresponding object model based on the Apache XML Beans parser.

The plugin produces two sets of output files referred to as generated sources and generated classes. The former is then compiled to the build outputDirectory. The latter is generated in this directory.

Note that the descriptions for the goal's parameters have been blatently copied from http://xmlbeans.apache.org/docs/2.0.0/guide/antXmlbean.html for convenience.

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Requires dependency resolution of artifacts in scope: compile
  • Automatically executes within the lifecycle phase: generate-sources

Required Parameters

Name Type Description
classGenerationDirectory File Set a location to generate CLASS files into.
pluginArtifacts List Appears to be dependencies of this plugin, to be added to the xmlbeans compile classpath.
schemaDirectory File The directory where .xsd files are to be found. Default value is ${basedir}/src/main/xsd.
sourceGenerationDirectory File Set a location to generate JAVA files into.
staleFile File The location of the flag file used to determine if the output is stale.

Optional Parameters

Name Type Description
catalogLocation File The location of the catalog used to resolve xml entities.
compiler String The compiler implementation to use. If this attribute is not set, the value of the build.compiler property, if set, will be used. Otherwise, the default compiler for the current VM will be used.
debug boolean Indicates whether source should be compiled with debug information; defaults to off. If set to off, -g:none will be passed on the command line for compilers that support it (for other compilers, no command line argument will be used). If set to true, the value of the debug level attribute determines the command line argument. Default value is false.
defaultXmlConfigDir File Default xmlConfigs directory. If no xmlConfigs list is specified, this one is checked automatically.
download boolean Set to true to permit the compiler to download URLs for imports and includes. Defaults to false, meaning all imports and includes must be copied locally. Default value is false.
generatedSchemaDirectory File The directory where .xsd's pulled from xsdJars will be stored. Default value is ${project.build.directory}/xmlbeans-xsds.
javaSource String Returns the javasource parameter which specifies an option to the XmlBeans code generator.
jaxb boolean Todo: Unkown use. Default value is false.
memoryInitialSize String The initial size of the memory for the underlying VM, if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
memoryMaximumSize String The maximum size of the memory for the underlying VM, if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
noAnn boolean Ignore annotations Default value is false.
noJavac boolean Don't compile the generated source files. Default value is false.
noPvr boolean Do not enforce the particle valid (restriction) rule. Default value is false.
noUpa boolean Do not enforce the unique particle attribution rule. Default value is false.
noVDoc boolean do not validate documentation elements Default value is false.
outputJar File Define the name of the jar file created. For instance, "myXMLBean.jar" will output the results of this task into a jar with the same name.
quiet boolean Supress the normal amount of console output. Default value is true.
sourceSchemas List A List of source schema files.
verbose boolean Controls the amount of build message output. Default value is false.
xmlConfigs List Configuration files used by the object generator. For more information about the format of these files, see Todo.
xsdJars List List of artifacts whose xsds need to be compiled.

Parameter Details

catalogLocation The location of the catalog used to resolve xml entities.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/catalog/resolver-catalog.xml
classGenerationDirectory Set a location to generate CLASS files into.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-classes/xmlbeans
compiler The compiler implementation to use. If this attribute is not set, the value of the build.compiler property, if set, will be used. Otherwise, the default compiler for the current VM will be used.
  • Type: java.lang.String
  • Required: No
debug Indicates whether source should be compiled with debug information; defaults to off. If set to off, -g:none will be passed on the command line for compilers that support it (for other compilers, no command line argument will be used). If set to true, the value of the debug level attribute determines the command line argument.
  • Type: boolean
  • Required: No
  • Default: false
defaultXmlConfigDir Default xmlConfigs directory. If no xmlConfigs list is specified, this one is checked automatically.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/xsdconfig
download Set to true to permit the compiler to download URLs for imports and includes. Defaults to false, meaning all imports and includes must be copied locally.
  • Type: boolean
  • Required: No
  • Default: false
generatedSchemaDirectory The directory where .xsd's pulled from xsdJars will be stored.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/xmlbeans-xsds
javaSource Returns the javasource parameter which specifies an option to the XmlBeans code generator.
  • Type: java.lang.String
  • Required: No
jaxb Todo: Unkown use.
  • Type: boolean
  • Required: No
  • Default: false
memoryInitialSize The initial size of the memory for the underlying VM, if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
  • Type: java.lang.String
  • Required: No
memoryMaximumSize The maximum size of the memory for the underlying VM, if javac is run externally; ignored otherwise. Defaults to the standard VM memory setting. (Examples: 83886080, 81920k, or 80m)
  • Type: java.lang.String
  • Required: No
noAnn Ignore annotations
  • Type: boolean
  • Required: No
  • Default: false
noJavac Don't compile the generated source files.
  • Type: boolean
  • Required: No
  • Default: false
noPvr Do not enforce the particle valid (restriction) rule.
  • Type: boolean
  • Required: No
  • Default: false
noUpa Do not enforce the unique particle attribution rule.
  • Type: boolean
  • Required: No
  • Default: false
noVDoc do not validate documentation elements
  • Type: boolean
  • Required: No
  • Default: false
outputJar Define the name of the jar file created. For instance, "myXMLBean.jar" will output the results of this task into a jar with the same name.
  • Type: java.io.File
  • Required: No
pluginArtifacts Appears to be dependencies of this plugin, to be added to the xmlbeans compile classpath.
  • Type: java.util.List
  • Required: Yes
  • Expression: ${plugin.artifacts}
quiet Supress the normal amount of console output.
  • Type: boolean
  • Required: No
  • Default: true
schemaDirectory The directory where .xsd files are to be found.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/src/main/xsd
sourceGenerationDirectory Set a location to generate JAVA files into.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-sources/xmlbeans
sourceSchemas A List of source schema files.
  • Type: java.util.List
  • Required: No
staleFile The location of the flag file used to determine if the output is stale.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-sources/xmlbeans/.staleFlag
verbose Controls the amount of build message output.
  • Type: boolean
  • Required: No
  • Default: false
xmlConfigs Configuration files used by the object generator. For more information about the format of these files, see Todo.
  • Type: java.util.List
  • Required: No
xsdJars List of artifacts whose xsds need to be compiled.
  • Type: java.util.List
  • Required: No