coneforest.ant.xjc

Class XjcTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

coneforest.ant.xjc.XjcTask

All Implemented Interfaces:

Cloneable

public class XjcTask
extends org.apache.tools.ant.Task

The XJC task.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XjcTask.Binding
static class	XjcTask.Schema

Constructor Summary

Constructors

Constructor and Description
XjcTask()

Method Summary

Modifier and Type	Method and Description
void	addConfiguredBinding(XjcTask.Binding binding) Add the nested binding element.
void	addConfiguredSchema(XjcTask.Schema schema) Add the nested schema element.
void	execute() Executes the task.
void	setCatalog(String value) Specifies catalog files to resolve external entity references.
void	setClasspath(org.apache.tools.ant.types.Path path) Specifies where to find user class files.
void	setClasspathRef(org.apache.tools.ant.types.Reference ref) Specifies where to find user class files as reference to a path.
void	setContentForWildcard(boolean value) Specifies whether generate content property for types with multiple xs:any derived elements.
void	setDestdir(String value) Specifies the directory where the generated files will go.
void	setDisableXmlSecurity(boolean value) Specifies whether the XML security features when parsing XML documents will be disabled.
void	setEnableIntrospection(boolean value) Specifies whether correct generation of Boolean getters/setters to enable Bean Introspection apis will be enabled.
void	setEncoding(String value) Specifies character encoding for generated source files.
void	setExtension(boolean value)
void	setFailOnError(boolean value) Specifies whether compilation errors will fail the build.
void	setFormat(String value) Specifies the format of the schema.
void	setHttpProxy(String value) Specifies HTTP/HTTPS proxy.
void	setHttpProxyFile(String value) Specifies HTTP/HTTPS proxy in a file to protect password.
void	setMarkGenerated(boolean value) Specifies whether the generated code will be marked as @Generated.
void	setNoHeader(boolean value) Specifies whether the generation of a file header with timestamp will be supressed.
void	setNoValidate(boolean value) Specifies whether strict validation of the input schema(s) will be supressed.
void	setPackage(String value) Specifies the target package.
void	setQuiet(boolean value) Specifies whether the XJC output will be supressed.
void	setReadonly(boolean value) Specifies whether generated files will be in read-only mode.
void	setRemoveOldInput(String value)
void	setSchema(String value)
void	setTarget(String value) Specifies whether XJC will behave like XJC 2.0 or 2.1 and generate code that doesn’t use any 2.2 features.
void	setVerbose(boolean value) Specifies whether the XJC output will be extra verbose.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, init, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XjcTask

public XjcTask()

Method Detail

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Executes the task.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - if there is an execution problem.

setDestdir

public void setDestdir(String value)

Specifies the directory where the generated files will go.

Parameters:

value - the name of the directory.

setSchema

public void setSchema(String value)

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path path)

Specifies where to find user class files.

Parameters:

path - the classpath.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference ref)

Specifies where to find user class files as reference to a path.

Parameters:

ref - the reference.

setPackage

public void setPackage(String value)

Specifies the target package.

Parameters:

value - the name of the target package.

setTarget

public void setTarget(String value)

Specifies whether XJC will behave like XJC 2.0 or 2.1 and generate code that doesn’t use any 2.2 features. Possible values are "2.0" or "2.1".

Parameters:

value - the target version.

setReadonly

public void setReadonly(boolean value)

Specifies whether generated files will be in read-only mode.

Parameters:

value - a Boolean value.

setVerbose

public void setVerbose(boolean value)

Specifies whether the XJC output will be extra verbose.

Parameters:

value - a Boolean value.

setQuiet

public void setQuiet(boolean value)

Specifies whether the XJC output will be supressed.

Parameters:

value - a Boolean value.

setEnableIntrospection

public void setEnableIntrospection(boolean value)

Specifies whether correct generation of Boolean getters/setters to enable Bean Introspection apis will be enabled.

Parameters:

value - a Boolean value.

setContentForWildcard

public void setContentForWildcard(boolean value)

Specifies whether generate content property for types with multiple xs:any derived elements.

Parameters:

value - a Boolean value.

setDisableXmlSecurity

public void setDisableXmlSecurity(boolean value)

Specifies whether the XML security features when parsing XML documents will be disabled.

Parameters:

value - a Boolean value.

setNoValidate

public void setNoValidate(boolean value)

Specifies whether strict validation of the input schema(s) will be supressed.

Parameters:

value - a Boolean value.

setNoHeader

public void setNoHeader(boolean value)

Specifies whether the generation of a file header with timestamp will be supressed.

Parameters:

value - a Boolean value.

setFormat

public void setFormat(String value)

Specifies the format of the schema. Possible values are "xmlschema", "relaxng", "relaxng-compact", "dtd", "wsdl".

Parameters:

value - the name of the format.

setExtension

public void setExtension(boolean value)

setFailOnError

public void setFailOnError(boolean value)

Specifies whether compilation errors will fail the build.

Parameters:

value - a Boolean value.

setMarkGenerated

public void setMarkGenerated(boolean value)

Specifies whether the generated code will be marked as @Generated.

Parameters:

value - a Boolean value.

setCatalog

public void setCatalog(String value)

Specifies catalog files to resolve external entity references. Support TR9401, XCatalog, and OASIS XML Catalog format.

Parameters:

value - the name of the catalog file.

setHttpProxy

public void setHttpProxy(String value)

Specifies HTTP/HTTPS proxy. Format is [user[:password]@]proxyHost:proxyPort.

Parameters:

value - the HTTP/HTTPS proxy.

setHttpProxyFile

public void setHttpProxyFile(String value)

Specifies HTTP/HTTPS proxy in a file to protect password.

Parameters:

value - the HTTP/HTTPS proxy.

See Also:

setHttpProxy(String)

setEncoding

public void setEncoding(String value)

Specifies character encoding for generated source files.

Parameters:

value - the character encoding.

setRemoveOldInput

public void setRemoveOldInput(String value)

addConfiguredSchema

public void addConfiguredSchema(XjcTask.Schema schema)

Add the nested schema element.

Parameters:

schema - the schema element.

addConfiguredBinding

public void addConfiguredBinding(XjcTask.Binding binding)

Add the nested binding element.

Parameters:

binding - the binding element.