CastorSourceGenTask (Castor JavaDoc)

java.lang.Object
- org.apache.tools.ant.ProjectComponent
- - org.apache.tools.ant.Task
  - - org.apache.tools.ant.taskdefs.MatchingTask
    - - org.exolab.castor.tools.ant.taskdefs.CastorSourceGenTask

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer
```
public final class CastorSourceGenTask
extends org.apache.tools.ant.taskdefs.MatchingTask
```
Deprecated.
Please use CastorCodeGenTask instead.

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

Field Summary
- Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
  fileset
- Fields inherited from class org.apache.tools.ant.ProjectComponent
  description, location, project
- Fields inherited from class org.apache.tools.ant.Task
  target, taskName, taskType, wrapper

Constructor Summary

Constructors
Constructor Description

CastorSourceGenTask()
Deprecated.

No-arg constructor.

Constructors
Constructor	Description
`CastorSourceGenTask()`	Deprecated. No-arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addFileset(org.apache.tools.ant.types.FileSet set)`	Deprecated. Adds a fileset to process that contains schemas to process.
`void`	`execute()`	Deprecated. Public execute method -- entry point for the Ant task.
`void`	`setBindingfile(java.lang.String bindingfile)`	Deprecated. Sets the binding file to be used for code generation.
`void`	`setCaseInsensitive(boolean caseInsensitive)`	Deprecated. Controls whether enumerated type lookup should be performed in a case insensitive manner.
`void`	`setDir(java.io.File dir)`	Deprecated. Sets the directory such that all schemas in this directory will have code generated for them.
`void`	`setFile(java.io.File file)`	Deprecated. Sets the individual schema that will have code generated for it.
`void`	`setGenerateImportedSchemas(boolean generateImportedSchemas)`	Deprecated. Controls whether to generate code for imported schemas as well.
`void`	`setLineseparator(java.lang.String ls)`	Deprecated. Sets the line seperator to use for code generation.
`void`	`setNodesc(boolean b)`	Deprecated. Sets whether or not class descriptors are generated.
`void`	`setNomarshal(boolean b)`	Deprecated. Sets whether or not marshaling methods are generated.
`void`	`setNomarshall(boolean b)`	Deprecated. For the correct spelling, see `setNomarshal(boolean)`.
`void`	`setPackage(java.lang.String pack)`	Deprecated. Sets the package that generated code will belong to.
`void`	`setProperties(java.lang.String properties)`	Deprecated. Sets the file to use for castor builder properties.
`void`	`setSAX1(boolean sax1)`	Deprecated. Controls whether to generate SAX-1 compliant code.
`void`	`setTestable(boolean b)`	Deprecated. Sets whether CTF framework code is generated.
`void`	`setTodir(java.lang.String dest)`	Deprecated. Sets the directory into which code will be generated.
`void`	`setTypes(java.lang.String tf)`	Deprecated. Sets the type factory for code generation.
`void`	`setVerbose(boolean b)`	Deprecated. Sets whether or not code generation gives extra information about its work.
`void`	`setWarnings(boolean b)`	Deprecated. 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 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation

Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

- Constructor Detail
  - CastorSourceGenTask
```
public CastorSourceGenTask()
```
    Deprecated.
    
    No-arg constructor.
- Method Detail
  - setFile
```
public void setFile(java.io.File file)
```
    Deprecated.
    
    Sets the individual schema that will have code generated for it.
    
    Parameters:
    
    file - One schema file.
  - setDir
```
public void setDir(java.io.File dir)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    Adds a fileset to process that contains schemas to process.
    
    Parameters:
    
    set - An individual file set containing schemas.
  - setPackage
```
public void setPackage(java.lang.String pack)
```
    Deprecated.
    
    Sets the package that generated code will belong to.
    
    Parameters:
    
    pack - The package that generated code will belong to.
  - setTodir
```
public void setTodir(java.lang.String dest)
```
    Deprecated.
    
    Sets the directory into which code will be generated.
    
    Parameters:
    
    dest - The directory into which code will be generated.
  - setBindingfile
```
public void setBindingfile(java.lang.String bindingfile)
```
    Deprecated.
    
    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(java.lang.String ls)
```
    Deprecated.
    
    Sets the line seperator to use for code generation.
    
    Parameters:
    
    ls - The line seperator to use for code generation.
  - setTypes
```
public void setTypes(java.lang.String tf)
```
    Deprecated.
    
    Sets the type factory for code generation.
    
    Parameters:
    
    tf - The type factory to use for code generation.
  - setVerbose
```
public void setVerbose(boolean b)
```
    Deprecated.
    
    Sets whether or not code generation gives extra information about its work.
    
    Parameters:
    
    b - If true, the code generator will be verbose.
  - setWarnings
```
public void setWarnings(boolean b)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    Sets whether or not class descriptors are generated.
    
    Parameters:
    
    b - If true, class descriptors are generated.
  - setNomarshall
```
public void setNomarshall(boolean b)
```
    Deprecated.
    For the correct spelling, see setNomarshal(boolean).
    
    Sets whether or not marshaling methods are generated.
    
    Parameters:
    
    b - If true, marshaling methods are generated.
  - setNomarshal
```
public void setNomarshal(boolean b)
```
    Deprecated.
    
    Sets whether or not marshaling methods are generated.
    
    Parameters:
    
    b - If true, marshaling methods are generated.
  - setTestable
```
public void setTestable(boolean b)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    Controls whether to generate code for imported schemas as well.
    
    Parameters:
    
    generateImportedSchemas - True if code should be generated for imported schemas.
  - setSAX1
```
public void setSAX1(boolean sax1)
```
    Deprecated.
    
    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)
```
    Deprecated.
    
    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(java.lang.String properties)
```
    Deprecated.
    
    Sets the file to use for castor builder properties.
    
    Parameters:
    
    properties - The properties to use.
  - execute
```
public void execute()
```
    Deprecated.
    
    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()

Class CastorSourceGenTask

Field Summary

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

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

CastorSourceGenTask

Method Detail

setFile

setDir

addFileset

setPackage

setTodir

setBindingfile

setLineseparator

setTypes

setVerbose

setWarnings

setNodesc

setNomarshall

setNomarshal

setTestable

setGenerateImportedSchemas

setSAX1

setCaseInsensitive

setProperties

execute