AbstractXmlBeansPlugin (Maven XML Beans Plugin 2.3.3 API)

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.codehaus.mojo.xmlbeans.AbstractXmlBeansPlugin

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CompileXmlBeansMojo, TestXmlBeansMojo
```
public abstract class AbstractXmlBeansPlugin
extends org.apache.maven.plugin.AbstractMojo
```
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.

Version:

$Id: AbstractXmlBeansPlugin.java 9412 2009-04-11 16:40:36Z david $

Author:

Brett Porter, Kris Bravo

Field Summary

Fields
Modifier and Type	Field and Description
`protected File`	`catalogLocation` The location of the catalog used to resolve xml entities.
`protected org.apache.maven.project.MavenProject`	`project` A reference to the Maven Project metadata.

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor and Description

AbstractXmlBeansPlugin()
Empty constructor for the XML Beans plugin.

Constructors
Constructor and Description
`AbstractXmlBeansPlugin()` Empty constructor for the XML Beans plugin.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`execute()` Map the parameters to the schema compilers parameter object, make sure the necessary output directories exist, then call on the schema compiler to produce the java objects and supporting resources.
`abstract File`	`getBaseDir()` Returns the directory where the schemas are located.
`String`	`getCatalogFile()` Returns the name of the file used to resolve xml entities.
`File[]`	`getClasspath()` Returns a classpath for the compiler made up of artifacts from the project.
`String`	`getCompiler()` Returns null.
`File[]`	`getConfigFiles()` Returns configuration files identified in the xmlConfigs string passed by the project configuration.
`abstract File`	`getDefaultXmlConfigDir()`
`EntityResolver`	`getEntityResolver()` Returns a null entity resolver.
`Collection`	`getErrorListeners()` Returns an empty collection the compiler will store error message Strings in.
`List`	`getExtensions()` Todo: Not certain of the purpose of this.
`File`	`getGeneratedClassesDirectory()` Returns the class directory of the project.
`protected abstract File`	`getGeneratedSchemaDirectory()`
`File`	`getGeneratedSourceDirectory()` Returns the directory for saving generated source files.
`File[]`	`getJavaFiles()` An array of other source files.
`String`	`getJavaSource()` Returns the javasource parameter which specifies an option to the XmlBeans code generator.
`Set`	`getMdefNamespaces()` Returns null at this time.
`String`	`getMemoryInitialSize()` Returns the initial size of the memory allocation for the schema compile process.
`String`	`getMemoryMaximumSize()` Returns the maximum size of the memory allocation for the schema compile process.
`String`	`getName()` Returns null at this time.
`File`	`getOutputJar()` Returns the location of the output jar file should one be produced.
`String`	`getRepackage()` Todo: Not certain of the purpose of this.
`abstract File`	`getSchemaDirectory()` Returns the directory where the schemas are located.
`abstract File`	`getStaleFile()`
`File[]`	`getWsdlFiles()` Returns a file array of wsdl files to translate to object models.
`File[]`	`getXsdFiles()` Returns a file array of xsd files to translate to object models.
`protected abstract List`	`getXsdJars()`
`boolean`	`hasCatalogFile()` Returns the name of the file used to resolve xml entities.
`boolean`	`isDebug()` Returns the state of debuggin.
`boolean`	`isDownload()` Returns true if dependencies are to be downloaded by the schema compiler.
`boolean`	`isJaxb()` Returns true if jaxb is set.
`boolean`	`isNoAnn()` If true, annotations in the schema are ignored
`boolean`	`isNoJavac()` Returns True if generated source files are not to be compiled.
`boolean`	`isNoPvr()` Do not enforce the particle valid (restriction) rule if true.
`boolean`	`isNoUpa()` If true, do not enforce the unique particle attribution rule.
`boolean`	`isNoVDoc()` If true, documentation elements in the source schema are ignored.
`boolean`	`isQuiet()` Returns true if the schema compiler should reduce verbosity.
`boolean`	`isVerbose()` Returns true if the schema compiler should increase verbosity.
`protected abstract void`	`updateProject(org.apache.maven.project.MavenProject project, org.apache.xmlbeans.impl.tool.SchemaCompiler.Parameters compilerParams, boolean stale)`
`void`	`validate()` No validation beyond those done by the maven plugin occur at this time.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - catalogLocation
```
protected File catalogLocation
```
    The location of the catalog used to resolve xml entities.
  - project
```
protected org.apache.maven.project.MavenProject project
```
    A reference to the Maven Project metadata.
- Constructor Detail
  - AbstractXmlBeansPlugin
```
public AbstractXmlBeansPlugin()
```
    Empty constructor for the XML Beans plugin.
- Method Detail
  - execute
```
public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException
```
    Map the parameters to the schema compilers parameter object, make sure the necessary output directories exist, then call on the schema compiler to produce the java objects and supporting resources.
    
    Specified by:
    
    execute in interface org.apache.maven.plugin.Mojo
    
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException - Errors occurred during compile.
  - updateProject
```
protected abstract void updateProject(org.apache.maven.project.MavenProject project,
                 org.apache.xmlbeans.impl.tool.SchemaCompiler.Parameters compilerParams,
                 boolean stale)
                               throws org.apache.maven.artifact.DependencyResolutionRequiredException,
                                      XmlBeansException
```
    Throws:
    
    org.apache.maven.artifact.DependencyResolutionRequiredException
    
    XmlBeansException
  - getXsdJars
```
protected abstract List getXsdJars()
```
  - getGeneratedSchemaDirectory
```
protected abstract File getGeneratedSchemaDirectory()
```
  - getBaseDir
```
public abstract File getBaseDir()
```
    Returns the directory where the schemas are located. Note that this is the base directory of the schema compiler, not the maven project.
    
    Returns:
    The schema directory.
  - getStaleFile
```
public abstract File getStaleFile()
```
  - getDefaultXmlConfigDir
```
public abstract File getDefaultXmlConfigDir()
```
  - getSchemaDirectory
```
public abstract File getSchemaDirectory()
```
    Returns the directory where the schemas are located. Note that this is the base directory of the schema compiler, not the maven project.
    
    Returns:
    The schema directory.
  - getClasspath
```
public final File[] getClasspath()
                          throws org.apache.maven.artifact.DependencyResolutionRequiredException
```
    Returns a classpath for the compiler made up of artifacts from the project.
    
    Returns:
    Array of classpath entries.
    
    Throws:
    
    org.apache.maven.artifact.DependencyResolutionRequiredException - Maven Dependencies weren't resolved.
  - getCompiler
```
public final String getCompiler()
```
    Returns null. Currently the compiler preference isn't passwed to the xml beans compiler.
    
    Returns:
    null.
  - getConfigFiles
```
public final File[] getConfigFiles()
                            throws XmlBeansException
```
    Returns configuration files identified in the xmlConfigs string passed by the project configuration. If none were identified, a check is made for the default xsd config directory src/xsdconfig.
    
    Returns:
    An array of configuration files.
    
    Throws:
    
    XmlBeansException
  - getEntityResolver
```
public final EntityResolver getEntityResolver()
```
    Returns a null entity resolver.
    
    Returns:
    entityResolver set to null.
  - getErrorListeners
```
public final Collection getErrorListeners()
```
    Returns an empty collection the compiler will store error message Strings in.
    
    Returns:
    An empty ArrayList.
  - getExtensions
```
public final List getExtensions()
```
    Todo: Not certain of the purpose of this.
    
    Returns:
    null at this time.
  - getJavaFiles
```
public final File[] getJavaFiles()
```
    An array of other source files. Currently an empty array.
    
    Returns:
    An empty file array.
  - getMdefNamespaces
```
public final Set getMdefNamespaces()
```
    Returns null at this time. Passed to the schema compiler.
    
    Returns:
    null.
  - getJavaSource
```
public final String getJavaSource()
```
    Returns the javasource parameter which specifies an option to the XmlBeans code generator.
    
    Returns:
    null.
  - getMemoryInitialSize
```
public final String getMemoryInitialSize()
```
    Returns the initial size of the memory allocation for the schema compile process.
    
    Returns:
    The initial memory size value.
  - getMemoryMaximumSize
```
public final String getMemoryMaximumSize()
```
    Returns the maximum size of the memory allocation for the schema compile process.
    
    Returns:
    The max memory size value.
  - getName
```
public final String getName()
```
    Returns null at this time. This is passed to the schema compiler.
    
    Returns:
    null.
  - getOutputJar
```
public final File getOutputJar()
```
    Returns the location of the output jar file should one be produced. If it has been set, make sure the directories exist before passing it to the xml beans compiler.
    
    Returns:
    The jar file location.
  - getRepackage
```
public final String getRepackage()
```
    Todo: Not certain of the purpose of this.
    
    Returns:
    null at this time.
  - hasCatalogFile
```
public final boolean hasCatalogFile()
```
    Returns the name of the file used to resolve xml entities.
    
    Returns:
    The entity resolver catalog file location.
  - getCatalogFile
```
public final String getCatalogFile()
```
    Returns the name of the file used to resolve xml entities.
    
    Returns:
    The entity resolver catalog file location.
  - getXsdFiles
```
public final File[] getXsdFiles()
                         throws XmlBeansException
```
    Returns a file array of xsd files to translate to object models.
    
    Returns:
    An array of schema files to be parsed by the schema compiler.
    
    Throws:
    
    XmlBeansException
  - getWsdlFiles
```
public final File[] getWsdlFiles()
                          throws XmlBeansException
```
    Returns a file array of wsdl files to translate to object models.
    
    Returns:
    An array of wsdl files to be parsed by the schema compiler.
    
    Throws:
    
    XmlBeansException
  - isDebug
```
public final boolean isDebug()
```
    Returns the state of debuggin.
    
    Returns:
    true if debug mode.
  - isDownload
```
public final boolean isDownload()
```
    Returns true if dependencies are to be downloaded by the schema compiler.
    
    Returns:
    true if resources should be downloaded.
  - isJaxb
```
public final boolean isJaxb()
```
    Returns true if jaxb is set.
    
    Returns:
    true if the jaxb flag on the schema compiler should be set.
  - isNoAnn
```
public final boolean isNoAnn()
```
    If true, annotations in the schema are ignored
    
    Returns:
    true if annotations in the source schema are to be ignored
  - isNoVDoc
```
public final boolean isNoVDoc()
```
    If true, documentation elements in the source schema are ignored.
    
    Returns:
  - isNoJavac
```
public final boolean isNoJavac()
```
    Returns True if generated source files are not to be compiled.
    
    Returns:
    true if no compiling should occur.
  - isNoPvr
```
public final boolean isNoPvr()
```
    Do not enforce the particle valid (restriction) rule if true.
    
    Returns:
    true if no enforcement should occur.
  - isNoUpa
```
public final boolean isNoUpa()
```
    If true, do not enforce the unique particle attribution rule.
    
    Returns:
    particle attibution enforcement
  - isQuiet
```
public final boolean isQuiet()
```
    Returns true if the schema compiler should reduce verbosity.
    
    Returns:
    true if message suppression is on.
  - isVerbose
```
public final boolean isVerbose()
```
    Returns true if the schema compiler should increase verbosity.
    
    Returns:
    true if verbose mode is on.
  - validate
```
public final void validate()
                    throws XmlBeansException
```
    No validation beyond those done by the maven plugin occur at this time.
    
    Throws:
    
    XmlBeansException - Currently not used.
  - getGeneratedSourceDirectory
```
public File getGeneratedSourceDirectory()
```
    Returns the directory for saving generated source files.
    
    Returns:
    The generated=sources directory.
  - getGeneratedClassesDirectory
```
public File getGeneratedClassesDirectory()
```
    Returns the class directory of the project.
    
    Returns:
    The project build classes directory.

Class AbstractXmlBeansPlugin

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

catalogLocation

project

Constructor Detail

AbstractXmlBeansPlugin

Method Detail

execute

updateProject

getXsdJars

getGeneratedSchemaDirectory

getBaseDir

getStaleFile

getDefaultXmlConfigDir

getSchemaDirectory

getClasspath

getCompiler

getConfigFiles

getEntityResolver

getErrorListeners

getExtensions

getJavaFiles

getMdefNamespaces

getJavaSource

getMemoryInitialSize

getMemoryMaximumSize

getName

getOutputJar

getRepackage

hasCatalogFile

getCatalogFile

getXsdFiles

getWsdlFiles

isDebug

isDownload

isJaxb

isNoAnn

isNoVDoc

isNoJavac

isNoPvr

isNoUpa

isQuiet

isVerbose

validate

getGeneratedSourceDirectory

getGeneratedClassesDirectory