org.castor.anttask

Class CastorCodeGenTask


public final class CastorCodeGenTask
extends 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) $
Authors:
Joel Farquhar
Bruce Snyder
Werner Guttmann

Constructor Summary

CastorCodeGenTask()
No-arg constructor.

Method Summary

void
addFileset(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
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
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.

Constructor Details

CastorCodeGenTask

public CastorCodeGenTask()
No-arg constructor.

Method Details

addFileset

public void addFileset(FileSet set)
Adds a fileset to process that contains schemas to process.
Parameters:
set - An individual file set containing schemas.

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.
See Also:
org.apache.tools.ant.Task.execute()

setAutomaticConflictStrategy

public void setAutomaticConflictStrategy(String automaticConflictStrategy)
Sets the name conflict strategy to use.
Parameters:
automaticConflictStrategy - The automatic class name conflict strategy to use

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.

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

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.

setFile

public void setFile(File file)
Sets the individual schema that will have code generated for it.
Parameters:
file - One schema file.

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.

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.

setNameConflictStrategy

public void setNameConflictStrategy(String nameConflictStrategy)
Sets the name conflict strategy to use.
Parameters:
nameConflictStrategy - The name conflict strategy to use

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.

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.

setProperties

public void setProperties(String properties)
Sets the file to use for castor builder properties.
Parameters:
properties - The properties to use.

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.

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.

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.

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.

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.

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.

Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com