castor:generate

Full name:

org.codehaus.mojo:castor-maven-plugin:2.1:generate

Description:

A mojo that uses Castor to generate a collection of javabeans from an XSD. Detailed explanations of many of these can be found in the details for the Castor SourceGenerator.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
project MavenProject - The Maven project to act upon.

Optional Parameters

Name Type Since Description
bindingfile File - The binding file to use for mapping xml to java.
classGenerationMode String - The method to use for Java class generation; possible values are 'standard' (default) and 'velocity'.
Default value is: standard.
createJdoDescriptors boolean - Whether to generate JDO-specific descriptor classes or not.
Default value is: false.
descriptors boolean - If true, generate descriptors
Default value is: true.
dest File - The directory to output the generated sources to
generateImportedSchemas boolean - Whether to generate Java classes from imported XML schemas or not.
Default value is: false.
generateMappings boolean - Set to true to generate Castor XML class mappings for the Java classes generated by the XML code generator from imported XML schemas.
Default value is: false.
lineSeparator String - The line separator to use in generated source. Can be either win, unix, or mac
marshal boolean - if false, don't generate the marshaller
Default value is: true.
packaging String - The package for the generated source
properties File - The castorbuilder.properties file to use
resourceDestination File - The directory to output generated resources files to.
schema File - A schema file to process. If this is not set then all .xsd files in schemaDirectory will be processed.
schemaDirectory File - The source directory containing *.xsd files
staleMillis int - The granularity in milliseconds of the last modification date for testing whether a source needs recompilation
Default value is: 0.
tstamp File - The directory to store the processed xsds. The timestamps of these xsds are used to determine if the source for that xsd need to be regenerated
types String - Castor collection types. Allowable values are 'vector', 'arraylist', 'j2' or 'odmg' 'j2' and 'arraylist' are the same.
Default value is: arraylist.
verbose boolean - Verbose output during generation
Default value is: false.
warnings boolean - Enable warning messages
Default value is: false.

Parameter Details

bindingfile:

The binding file to use for mapping xml to java.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/castor/bindings.xml

classGenerationMode:

The method to use for Java class generation; possible values are 'standard' (default) and 'velocity'.
  • Type: java.lang.String
  • Required: No
  • Default: standard

createJdoDescriptors:

Whether to generate JDO-specific descriptor classes or not.
  • Type: boolean
  • Required: No
  • Default: false

descriptors:

If true, generate descriptors
  • Type: boolean
  • Required: No
  • Default: true

dest:

The directory to output the generated sources to
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/generated-sources/castor

generateImportedSchemas:

Whether to generate Java classes from imported XML schemas or not.
  • Type: boolean
  • Required: No
  • Default: false

generateMappings:

Set to true to generate Castor XML class mappings for the Java classes generated by the XML code generator from imported XML schemas.
  • Type: boolean
  • Required: No
  • Default: false

lineSeparator:

The line separator to use in generated source. Can be either win, unix, or mac
  • Type: java.lang.String
  • Required: No

marshal:

if false, don't generate the marshaller
  • Type: boolean
  • Required: No
  • Default: true

packaging:

The package for the generated source
  • Type: java.lang.String
  • Required: No

project:

The Maven project to act upon.
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • Expression: ${project}

properties:

The castorbuilder.properties file to use
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/castor/castorbuilder.properties

resourceDestination:

The directory to output generated resources files to.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/generated-sources/castor

schema:

A schema file to process. If this is not set then all .xsd files in schemaDirectory will be processed.
  • Type: java.io.File
  • Required: No

schemaDirectory:

The source directory containing *.xsd files
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/main/castor

staleMillis:

The granularity in milliseconds of the last modification date for testing whether a source needs recompilation
  • Type: int
  • Required: No
  • Expression: ${lastModGranularityMs}
  • Default: 0

tstamp:

The directory to store the processed xsds. The timestamps of these xsds are used to determine if the source for that xsd need to be regenerated
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/xsds

types:

Castor collection types. Allowable values are 'vector', 'arraylist', 'j2' or 'odmg' 'j2' and 'arraylist' are the same.
  • Type: java.lang.String
  • Required: No
  • Default: arraylist

verbose:

Verbose output during generation
  • Type: boolean
  • Required: No
  • Default: false

warnings:

Enable warning messages
  • Type: boolean
  • Required: No
  • Default: false