org.codehaus.mojo.xmlbeans
public abstract class AbstractXmlBeansPlugin extends org.apache.maven.plugin.AbstractMojo
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.
Modifier and Type | Field and Description |
---|---|
protected java.io.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.
|
Constructor and Description |
---|
AbstractXmlBeansPlugin()
Empty constructor for the XML Beans plugin.
|
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 java.io.File |
getBaseDir()
Returns the directory where the schemas are located.
|
java.lang.String |
getCatalogFile()
Returns the name of the file used to resolve xml entities.
|
java.io.File[] |
getClasspath()
Returns a classpath for the compiler made up of artifacts from the
project.
|
java.lang.String |
getCompiler()
Returns null.
|
java.io.File[] |
getConfigFiles()
Returns configuration files identified in the xmlConfigs string passed by
the project configuration.
|
abstract java.io.File |
getDefaultXmlConfigDir() |
org.xml.sax.EntityResolver |
getEntityResolver()
Returns a null entity resolver.
|
java.util.Collection |
getErrorListeners()
Returns an empty collection the compiler will store error message Strings
in.
|
java.util.List |
getExtensions()
Todo: Not certain of the purpose of this.
|
java.io.File |
getGeneratedClassesDirectory()
Returns the class directory of the project.
|
protected abstract java.io.File |
getGeneratedSchemaDirectory() |
java.io.File |
getGeneratedSourceDirectory()
Returns the directory for saving generated source files.
|
java.io.File[] |
getJavaFiles()
An array of other source files.
|
java.lang.String |
getJavaSource()
Returns the javasource parameter which specifies an option to
the XmlBeans code generator.
|
java.util.Set |
getMdefNamespaces()
Returns null at this time.
|
java.lang.String |
getMemoryInitialSize()
Returns the initial size of the memory allocation for the schema compile
process.
|
java.lang.String |
getMemoryMaximumSize()
Returns the maximum size of the memory allocation for the schema compile
process.
|
java.lang.String |
getName()
Returns null at this time.
|
java.io.File |
getOutputJar()
Returns the location of the output jar file should one be produced.
|
java.lang.String |
getRepackage()
Todo: Not certain of the purpose of this.
|
abstract java.io.File |
getSchemaDirectory()
Returns the directory where the schemas are located.
|
abstract java.io.File |
getStaleFile() |
java.io.File[] |
getWsdlFiles()
Returns a file array of wsdl files to translate to object models.
|
java.io.File[] |
getXsdFiles()
Returns a file array of xsd files to translate to object models.
|
protected abstract java.util.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.
|
protected java.io.File catalogLocation
protected org.apache.maven.project.MavenProject project
public AbstractXmlBeansPlugin()
public final void execute() throws org.apache.maven.plugin.MojoExecutionException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
- Errors occurred during compile.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
org.apache.maven.artifact.DependencyResolutionRequiredException
XmlBeansException
protected abstract java.util.List getXsdJars()
protected abstract java.io.File getGeneratedSchemaDirectory()
public abstract java.io.File getBaseDir()
public abstract java.io.File getStaleFile()
public abstract java.io.File getDefaultXmlConfigDir()
public abstract java.io.File getSchemaDirectory()
public final java.io.File[] getClasspath() throws org.apache.maven.artifact.DependencyResolutionRequiredException
org.apache.maven.artifact.DependencyResolutionRequiredException
- Maven Dependencies weren't resolved.public final java.lang.String getCompiler()
public final java.io.File[] getConfigFiles() throws XmlBeansException
XmlBeansException
public final org.xml.sax.EntityResolver getEntityResolver()
public final java.util.Collection getErrorListeners()
public final java.util.List getExtensions()
public final java.io.File[] getJavaFiles()
public final java.util.Set getMdefNamespaces()
public final java.lang.String getJavaSource()
public final java.lang.String getMemoryInitialSize()
public final java.lang.String getMemoryMaximumSize()
public final java.lang.String getName()
public final java.io.File getOutputJar()
public final java.lang.String getRepackage()
public final boolean hasCatalogFile()
public final java.lang.String getCatalogFile()
public final java.io.File[] getXsdFiles() throws XmlBeansException
XmlBeansException
public final java.io.File[] getWsdlFiles() throws XmlBeansException
XmlBeansException
public final boolean isDebug()
public final boolean isDownload()
public final boolean isJaxb()
public final boolean isNoAnn()
public final boolean isNoVDoc()
public final boolean isNoJavac()
public final boolean isNoPvr()
public final boolean isNoUpa()
public final boolean isQuiet()
public final boolean isVerbose()
public final void validate() throws XmlBeansException
XmlBeansException
- Currently not used.public java.io.File getGeneratedSourceDirectory()
public java.io.File getGeneratedClassesDirectory()
Copyright © 2005-2014. All Rights Reserved.