A Java Source generation tool which uses XML Schema definitions
to create an Object model.
boundPropertiesEnabled
public static boolean boundPropertiesEnabled()
Returns true if bound properties are enabled.
Enabling bound properties is controlled via
the org.exolab.castor.builder.boundproperties item
in the castorbuilder.properties file. The value is
either 'true' or 'false'.
- true if bound properties are enabled.
classDescFieldNames
public static boolean classDescFieldNames()
Returns true if we generate a 'public static final String' for the
name of each attribute and element described by the class descriptor
Enabling this property is controlled via
the org.exolab.castor.builder.classdescfieldnames item
in the castorbuilder.properties file. The value is
either 'true' or 'false'.
- true if bound properties are enabled.
equalsMethod
public static boolean equalsMethod()
Returns true if we generate an 'equals' method for
each generated class.
Enabling this property is controlled via
the org.exolab.castor.builder.equalsmethod item
in the castorbuilder.properties file. The value is
either 'true' or 'false'.
- true if bound properties are enabled.
generateExtraCollectionMethods
public static boolean generateExtraCollectionMethods()
Returns true if extra methods for collection fields should
be generated. Such methods include set/get methods for
the actual collection in addition to the array methods.
Enabling extra collection methods is controlled via
the org.exolab.castor.builder.extraCollectionMethods
property in the castorbuilder.properties file. The value is
either 'true' or 'false'.
- true if extra collection methods are enabled.
generateSource
public void generateSource(InputSource source,
String packageName)
Creates Java Source code (Object model) for the given XML Schema
packageName
- the package for the generated source files
generateSource
public void generateSource(Reader reader,
String packageName)
Creates Java Source code (Object model) for the given XML Schema.
reader
- the Reader with which to read the XML Schema definition.
The caller should close the reader, since thie method will not do so.packageName
- the package for the generated source files
generateSource
public void generateSource(String filename,
String packageName)
throws java.io.FileNotFoundException
Creates Java Source code (Object model) for the given XML Schema.
filename
- the full path to the XML Schema definitionpackageName
- the package for the generated source files
generateSource
public void generateSource(Schema schema,
String packageName)
Creates Java Source code (Object model) for the given XML Schema.
schema
- the XML schema to generate the Java sources for.packageName
- the package for the generated source files.
getDefault
public static Properties getDefault()
Returns the default configuration file. Changes to the returned
properties set will affect all Castor functions relying on the
default configuration.
- The default configuration
getProperty
public static String getProperty(String name,
String defValue)
Returns a property from the default configuration file.
Equivalent to calling
getProperty on the result
of
getDefault()
.
getVersion
public static String getVersion()
Returns the version number of this SourceGenerator
- the version number of this SourceGenerator
initBindingType
protected static void initBindingType()
Called by #load to initialize the binding type
load
protected static void load()
Called by
getDefault()
to load the configuration the
first time. Will not complain about inability to load
configuration file from one of the default directories, but if
it cannot find the JAR's configuration file, will throw a
run time exception.
lookupPackageLocation
public static String lookupPackageLocation(String schemaLocation)
Gets a Java package to a schema location.
lookupPackageNamespace
public static String lookupPackageNamespace(String nsURL)
Gets a Java package to an XML namespace URL
main
public static void main(String[] args)
main class used for command line invocation
args
- the String[] consisting of the command line arguments
mappingSchemaElement2Java
public static boolean mappingSchemaElement2Java()
Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.
- True if the Source Generator is mapping schema elements to Java classes.
mappingSchemaType2Java
public static boolean mappingSchemaType2Java()
Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.
- True if the Source Generator is mapping schema types to Java classes.
processNamespacePackageMappings
protected static void processNamespacePackageMappings(String mappings)
setBinding
public void setBinding(InputSource source)
Sets the binding to use given an InputSource identifying
a Castor Binding File.
source
- an InputSource identifying a Castor Binding File.
setBinding
public void setBinding(String fileName)
Sets the binding to use given the path name of a Castor Binding File.
fileName
- the file that represents a Binding
setBinding
public void setBinding(ExtendedBinding binding)
Sets the binding to use with this instance of the SourceGenerator.
binding
- the binding to use, null indicates that the default
binding will be used.
setClassDescFieldNames
public static void setClassDescFieldNames(boolean classDescFieldNames)
Sets the 'classDescFieldNames' property
setCreateMarshalMethods
public void setCreateMarshalMethods(boolean createMarshalMethods)
Sets whether or not to create the XML marshalling framework specific
methods (marshall, unmarshall, validate) in the generated classes.
By default, these methods are generated.
createMarshalMethods
- a boolean, when true indicates
to generated the marshalling framework methods
setDefaultProperties
public static void setDefaultProperties(Properties properties)
Override the properties
setDescriptorCreation
public void setDescriptorCreation(boolean createDescriptors)
Sets whether or not to create ClassDescriptors for
the generated classes. By default, descriptors are
generated.
createDescriptors
- a boolean, when true indicates
to generated ClassDescriptors
setDestDir
public void setDestDir(String destDir)
Sets the destination directory.
destDir
- the destination directory.
setEqualsMethod
public static void setEqualsMethod(boolean equals)
Sets the 'equalsmethod' property
setLineSeparator
public void setLineSeparator(String lineSeparator)
Sets the line separator to use when printing the source code
lineSeparator
- the line separator to use when printing
the source code. This method is useful if you are generating
source on one platform, but will be compiling the source
on a different platform.
Note:This can be any string, so be careful. I recommend
either using the default or using one of the following:
windows systems use: "\r\n"
unix systems use: "\n"
mac systems use: "\r"
setPrimitiveWrapper
public static void setPrimitiveWrapper(boolean wrapper)
Sets the 'primitivetowrapper' property
setSAX1
public void setSAX1(boolean sax1)
Set to true if SAX1 should be used in the marshall method
setSuppressNonFatalWarnings
public void setSuppressNonFatalWarnings(boolean suppress)
setTestable
public void setTestable(boolean testable)
Sets whether or not to create the XML marshalling framework specific
methods (marshall, unmarshall, validate) in the generated classes.
By default, these methods are generated.
setVerbose
public void setVerbose(boolean verbose)
Sets whether or not the source code generator prints
additional messages during generating source code
verbose
- a boolean, when true indicates to
print additional messages
toURIRepresentation
public static String toURIRepresentation(String path)
Returns a string which is the URI of a file.
- file:///DOSpath
- file://UnixPath
No validation is done to check wether the file exists or not.
This method will be no longer used when the JDK URL.toString() is
fixed.
path
- the absolute path of the file.
usePrimitiveWrapper
public static boolean usePrimitiveWrapper()
Returns true if primitive types have to be used
as Objects (eg. replacing float by java.lang.Float).