org.castor.anttask
Class CastorCodeGenTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.tools.ant.taskdefs.MatchingTask
              org.castor.anttask.CastorCodeGenTask

All Implemented Interfaces:

org.apache.tools.ant.types.selectors.SelectorContainer

public final class CastorCodeGenTask
extends org.apache.tools.ant.taskdefs.MatchingTask

An Ant task to call the Castor Source Generator. It can be passed a file, a directory, a Fileset or all three.

Version:

$Revision: 6543 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Joel Farquhar, Bruce Snyder, Werner Guttmann

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

CastorCodeGenTask()
No-arg constructor.

Method Summary

void	addFileset(org.apache.tools.ant.types.FileSet set) Adds a fileset to process that contains schemas to process.
void	execute() Public execute method -- entry point for the Ant task.
void	setAutomaticConflictStrategy(String automaticConflictStrategy) Sets the name conflict strategy to use.
void	setBindingfile(String bindingfile) Sets the binding file to be used for code generation.
void	setCaseInsensitive(boolean caseInsensitive) Controls whether enumerated type lookup should be performed in a case insensitive manner.
void	setDir(File dir) Sets the directory such that all schemas in this directory will have code generated for them.
void	setFile(File file) Sets the individual schema that will have code generated for it.
void	setGenerateImportedSchemas(boolean generateImportedSchemas) Controls whether to generate code for imported schemas as well.
void	setGenerateJdoDescriptors(boolean generateJdoDescriptors) Controls whether to generate JDO-specific class descriptors.
void	setGenerateMapping(boolean generateMapping) Controls whether a mapping file should (additionally) be generated.
void	setJClassPrinterType(String jclassPrinterType) Sets the mode for printing JClass instances.
void	setLineseparator(String ls) Sets the line seperator to use for code generation.
void	setNameConflictStrategy(String nameConflictStrategy) Sets the name conflict strategy to use.
void	setNodesc(boolean b) Sets whether or not class descriptors are generated.
void	setNomarshal(boolean b) Sets whether or not marshaling methods are generated.
void	setPackage(String pack) Sets the package that generated code will belong to.
void	setProperties(String properties) Sets the file to use for castor builder properties.
void	setResourcesDirectory(String destination) Sets the directory into which resources will be generated.
void	setSAX1(boolean sax1) Controls whether to generate SAX-1 compliant code.
void	setSchemaURL(String schemaURL) Sets an URL for one individual schema that will have code generated for it.
void	setTestable(boolean b) Sets whether CTF framework code is generated.
void	setTodir(String dest) Sets the directory into which code will be generated.
void	setTypes(String tf) Sets the type factory for code generation.
void	setVerbose(boolean b) Sets whether or not code generation gives extra information about its work.
void	setWarnings(boolean b) Sets whether or not non-fatal warnings should be suppressed.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

getProject

Methods inherited from class java.lang.Object

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

Constructor Detail

CastorCodeGenTask

public CastorCodeGenTask()

No-arg constructor.

Method Detail

setFile

public void setFile(File file)

Sets the individual schema that will have code generated for it.

Parameters:

file - One schema file.

setSchemaURL

public void setSchemaURL(String schemaURL)

Sets an URL for one individual schema that will have code generated for it.

Parameters:

schemaURL - URL for one schema file.

setDir

public void setDir(File dir)

Sets the directory such that all schemas in this directory will have code generated for them.

Parameters:

dir - The directory containing schemas to process.

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)

Adds a fileset to process that contains schemas to process.

Parameters:

set - An individual file set containing schemas.

setPackage

public void setPackage(String pack)

Sets the package that generated code will belong to.

Parameters:

pack - The package that generated code will belong to.

setTodir

public void setTodir(String dest)

Sets the directory into which code will be generated.

Parameters:

dest - The directory into which code will be generated.

setResourcesDirectory

public void setResourcesDirectory(String destination)

Sets the directory into which resources will be generated. If not specified, resources will be generated in the same location as code.

Parameters:

dest - The directory into which resources will be generated.

setBindingfile

public void setBindingfile(String bindingfile)

Sets the binding file to be used for code generation.

Parameters:

bindingfile - The binding file to be used for code generation.

setLineseparator

public void setLineseparator(String ls)

Sets the line seperator to use for code generation.

Parameters:

ls - The line seperator to use for code generation.

setTypes

public void setTypes(String tf)

Sets the type factory for code generation.

Parameters:

tf - The type factory to use for code generation.

setVerbose

public void setVerbose(boolean b)

Sets whether or not code generation gives extra information about its work.

Parameters:

b - If true, the code generator will be verbose.

setNameConflictStrategy

public void setNameConflictStrategy(String nameConflictStrategy)

Sets the name conflict strategy to use.

Parameters:

nameConflictStrategy - The name conflict strategy to use

setAutomaticConflictStrategy

public void setAutomaticConflictStrategy(String automaticConflictStrategy)

Sets the name conflict strategy to use.

Parameters:

automaticConflictStrategy - The automatic class name conflict strategy to use

setWarnings

public void setWarnings(boolean b)

Sets whether or not non-fatal warnings should be suppressed.

Parameters:

b - If true, non-fatal warnings will be suppressed. This additionally means that existing source files will be silently overwritten.

setNodesc

public void setNodesc(boolean b)

Sets whether or not class descriptors are generated.

Parameters:

b - If true, class descriptors are generated.

setNomarshal

public void setNomarshal(boolean b)

Sets whether or not marshaling methods are generated.

Parameters:

b - If true, marshaling methods are generated.

setTestable

public void setTestable(boolean b)

Sets whether CTF framework code is generated.

Parameters:

b - If true, the generated code will be instrumented for the CTF.

setGenerateImportedSchemas

public void setGenerateImportedSchemas(boolean generateImportedSchemas)

Controls whether to generate code for imported schemas as well.

Parameters:

generateImportedSchemas - True if code should be generated for imported schemas.

setGenerateJdoDescriptors

public void setGenerateJdoDescriptors(boolean generateJdoDescriptors)

Controls whether to generate JDO-specific class descriptors.

Parameters:

generateJdoDescriptors - True if JDP class descriptors should be generated

setSAX1

public void setSAX1(boolean sax1)

Controls whether to generate SAX-1 compliant code.

Parameters:

sax1 - True if SAX-1 compliant code should be generated.

setCaseInsensitive

public void setCaseInsensitive(boolean caseInsensitive)

Controls whether enumerated type lookup should be performed in a case insensitive manner.

Parameters:

caseInsensitive - True if enumerated type lookup should be performed in a case insensitive manner

setProperties

public void setProperties(String properties)

Sets the file to use for castor builder properties.

Parameters:

properties - The properties to use.

setJClassPrinterType

public void setJClassPrinterType(String jclassPrinterType)

Sets the mode for printing JClass instances.

Parameters:

jclassPrinterType - The mode for printing JClass instances.

setGenerateMapping

public void setGenerateMapping(boolean generateMapping)

Controls whether a mapping file should (additionally) be generated.

Parameters:

generateMapping - True if a mapping file should be generated.

execute

public void execute()

Public execute method -- entry point for the Ant task. Loops over all schema that need code generated and creates needed code generators, then executes them. If anything goes wrong during execution of the Ant task a BuildException will be thrown.

Overrides:

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

See Also:

Task.execute()