BuilderConfiguration (Castor XML - Code generator 1.4.1 API)

java.lang.Object
- org.exolab.castor.builder.BuilderConfiguration

Direct Known Subclasses:

SourceGenerator
```
public class BuilderConfiguration
extends Object
```
The configuration for the SourceGenerator. HACK this class is a configuration but does not base on Castor Configuration! Raised CASTOR-2195 to solve this issue.

Version:

$Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Keith Visco, Arnaud Blandin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BuilderConfiguration.Property
Names of properties used in the configuration file.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BuilderConfiguration.Property` Names of properties used in the configuration file.

Constructor Summary

Constructors
Constructor and Description

BuilderConfiguration()
Creates a default BuilderConfiguration.

Constructors
Constructor and Description
`BuilderConfiguration()` Creates a default BuilderConfiguration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotationBuilder(AnnotationBuilder annotationBuilder)` adds a custom annotation builder.
`boolean`	`boundPropertiesEnabled()` Returns true if bound properties are enabled.
`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
`boolean`	`equalsMethod()` Returns true if we generate an 'equals' method for each generated class.
`void`	`forceUseJava50()` Add support to set java version programmatically.
`boolean`	`generateExtraCollectionMethods()` Returns true if extra methods for collection fields should be generated.
`boolean`	`generateExtraDocumentationMethods()` Returns true if extra methods for accessing XML schema documentation should be generated; default to 'false'.
`AnnotationBuilder[]`	`getAnnotationBuilders()` returns all applied annotation builders.
`String`	`getAutomaticConflictResolutionTypeSuffix()` Returns the type 'suffix' used for the type strategy during automatic class name conflict resolution during XML code generation; default to "" unless a value is specified.
`Properties`	`getDefault()` Returns the default configuration file.
`JavaNaming`	`getJavaNaming()` To get the `JavaNaming` implementation to be used.
`String`	`getJClassPrinterFactories()` Returns a String representing the list of `JClassPrinterFactory` instances configured in the Castor XML code generator property file.
`int`	`getMaximumNumberOfConstants()` Returns the maximum number of static constant definitions that are acceptable within one class file; default is 1000.
`String`	`getProperty(String name, String defValue)` Returns a property from the default configuration file.
`boolean`	`isAutomaticConflictResolution()` indicates whether automatic class name conflict resolution during XML code generation should take place or not.
`protected void`	`load()` Called by `getDefault()` to load the configuration the first time.
`static Properties`	`loadProperties(String resourceName, String fileName)` Load the configuration 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.
`String`	`lookupPackageByLocation(String schemaLocation)` Converts a schema location into a Java package.
`String`	`lookupPackageByNamespace(String nsURL)` Gets a Java package to an XML namespace URL.
`boolean`	`mappingSchemaElement2Java()` Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.
`boolean`	`mappingSchemaType2Java()` Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.
`protected void`	`processNamespacePackageMappings(String mappings)` processes the given String which contains namespace-to-package mappings.
`void`	`setClassDescFieldNames(boolean classDescFieldNames)` Sets the 'classDescFieldNames' property.
`void`	`setDefaultProperties(Properties properties)` Overrides the current set of properties with the given properties.
`void`	`setEqualsMethod(boolean equals)` Sets the 'equalsmethod' property.
`void`	`setJavaNaming(JavaNaming javaNaming)` To set the `JavaNaming` implementation to be used.
`void`	`setLocationPackageMapping(String schemaLocation, String packageName)` Sets the schemaLocation to package mapping.
`void`	`setNamespacePackageMapping(String ns, String packageName)` Sets the namespace to package mapping.
`void`	`setPrimitiveWrapper(boolean wrapper)` Sets the 'primitivetowrapper' property.
`void`	`setUseEnumeratedTypeInterface(boolean flag)` Sets the 'enumTypeAccessInterface' property.
`boolean`	`useCycleBreaker()` Returns true if the class `CycleBreaker` should be used during code generation; defaults to 'true'.
`boolean`	`useEnumeratedTypeInterface()` Returns true if we generate the implements EnumeratedTypeAccess interface for enumerated type classes.
`boolean`	`useJava50()` Returns true if we generate the implements EnumeratedTypeAccess interface for enumerated type classes.
`boolean`	`useJava5Enums()` Indicates what kind of enumeration should be created for <xs:simpleType> enumerations.
`boolean`	`useOldFieldNaming()`
`boolean`	`usePrimitiveWrapper()` Returns true if primitive types have to be used as Objects (eg.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BuilderConfiguration
```
public BuilderConfiguration()
```
    Creates a default BuilderConfiguration.
- Method Detail
  - getDefault
```
public final Properties getDefault()
```
    Returns the default configuration file. Changes to the returned properties set will affect all Castor functions relying on the default configuration.
    
    Returns:
    
    The default configuration
  - getProperty
```
public final String getProperty(String name,
                                String defValue)
```
    Returns a property from the default configuration file. Equivalent to calling getProperty on the result of getDefault().
    
    Parameters:
    
    name - The property name
    
    defValue - The property's default value
    
    Returns:
    
    The property's value
  - boundPropertiesEnabled
```
public final 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'.
    
    Returns:
    
    true if bound properties are enabled.
  - equalsMethod
```
public final 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'.
    
    Returns:
    
    true if bound properties are enabled.
  - setEqualsMethod
```
public final void setEqualsMethod(boolean equals)
```
    Sets the 'equalsmethod' property.
    
    Parameters:
    
    equals - The value we want to use.
  - classDescFieldNames
```
public final 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'.
    
    Returns:
    
    true if bound properties are enabled.
  - generateExtraCollectionMethods
```
public final 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'.
    
    Returns:
    
    true if extra collection methods are enabled.
  - setClassDescFieldNames
```
public final void setClassDescFieldNames(boolean classDescFieldNames)
```
    Sets the 'classDescFieldNames' property.
    
    Parameters:
    
    classDescFieldNames - the value we want to ues
  - usePrimitiveWrapper
```
public final boolean usePrimitiveWrapper()
```
    Returns true if primitive types have to be used as Objects (eg. replacing float by java.lang.Float).
    
    Returns:
    
    true if primitive types have to be used as Objects.
  - setPrimitiveWrapper
```
public final void setPrimitiveWrapper(boolean wrapper)
```
    Sets the 'primitivetowrapper' property.
    
    Parameters:
    
    wrapper - the value we want to use.
  - useEnumeratedTypeInterface
```
public final boolean useEnumeratedTypeInterface()
```
    Returns true if we generate the implements EnumeratedTypeAccess interface for enumerated type classes. The value is either 'true' or 'false'
    
    Returns:
    
    true if use enumerated type interface is enabled
  - useJava50
```
public final boolean useJava50()
```
    Returns true if we generate the implements EnumeratedTypeAccess interface for enumerated type classes. The value is either 'true' or 'false'
    
    Returns:
    
    true if use enumerated type interface is enabled
  - useJava5Enums
```
public final boolean useJava5Enums()
```
    Indicates what kind of enumeration should be created for <xs:simpleType> enumerations.
    
    Returns:
    
    true if Java 5 source code should be generated.
  - forceUseJava50
```
public final void forceUseJava50()
```
    Add support to set java version programmatically.
  - generateExtraDocumentationMethods
```
public final boolean generateExtraDocumentationMethods()
```
    Returns true if extra methods for accessing XML schema documentation should be generated; default to 'false'.
    
    Returns:
    
    true if if extra methods for accessing XML schema documentation should be generated
  - useCycleBreaker
```
public final boolean useCycleBreaker()
```
    Returns true if the class CycleBreaker should be used during code generation; defaults to 'true'.
    
    Returns:
    
    true if the class CycleBreaker should be used during code generation
  - getMaximumNumberOfConstants
```
public final int getMaximumNumberOfConstants()
```
    Returns the maximum number of static constant definitions that are acceptable within one class file; default is 1000.
    
    Returns:
    
    the maximum number of static constant definitions acceptable within one class file
  - setUseEnumeratedTypeInterface
```
public final void setUseEnumeratedTypeInterface(boolean flag)
```
    Sets the 'enumTypeAccessInterface' property.
    
    Parameters:
    
    flag - the value we want to use
  - mappingSchemaElement2Java
```
public boolean mappingSchemaElement2Java()
```
    Tests the org.exolab.castor.builder.javaclassmapping property for the 'element' value.
    
    Returns:
    
    True if the Source Generator is mapping schema elements to Java classes.
  - mappingSchemaType2Java
```
public boolean mappingSchemaType2Java()
```
    Tests the org.exolab.castor.builder.javaclassmapping property for the 'type' value.
    
    Returns:
    
    True if the Source Generator is mapping schema types to Java classes.
  - setDefaultProperties
```
public final void setDefaultProperties(Properties properties)
```
    Overrides the current set of properties with the given properties. Once the properties are set, only a copy will be uses, so any changes to the given properties file after the fact will go unnoticed.
    
    Parameters:
    
    properties - the Properties file
  - setNamespacePackageMapping
```
public final void setNamespacePackageMapping(String ns,
                                             String packageName)
```
    Sets the namespace to package mapping.
    
    Parameters:
    
    ns - the namespace URI to map
    
    packageName - the package name
  - setLocationPackageMapping
```
public final void setLocationPackageMapping(String schemaLocation,
                                            String packageName)
```
    Sets the schemaLocation to package mapping.
    
    Parameters:
    
    schemaLocation - the schemaLocation to map
    
    packageName - the package name to map to
  - getJClassPrinterFactories
```
public final String getJClassPrinterFactories()
```
    Returns a String representing the list of JClassPrinterFactory instances configured in the Castor XML code generator property file.
    
    Returns:
    
    the list of JClassPrinterFactory instances as configured, as string.
  - load
```
protected final 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.
  - lookupPackageByNamespace
```
public final String lookupPackageByNamespace(String nsURL)
```
    Gets a Java package to an XML namespace URL.
    
    Parameters:
    
    nsURL - the XML namespace URL to convert into a Java package name
    
    Returns:
    
    a Java package name
  - lookupPackageByLocation
```
public final String lookupPackageByLocation(String schemaLocation)
```
    Converts a schema location into a Java package.
    
    Parameters:
    
    schemaLocation - the Schema location to use to look up the Java package
    
    Returns:
    
    a Java package name
  - processNamespacePackageMappings
```
protected final void processNamespacePackageMappings(String mappings)
```
    processes the given String which contains namespace-to-package mappings.
    
    Parameters:
    
    mappings - the namespace-to-package mappings
  - isAutomaticConflictResolution
```
public boolean isAutomaticConflictResolution()
```
    indicates whether automatic class name conflict resolution during XML code generation should take place or not.
    
    Returns:
    
    True if automatic mode should be used.
  - getAutomaticConflictResolutionTypeSuffix
```
public String getAutomaticConflictResolutionTypeSuffix()
```
    Returns the type 'suffix' used for the type strategy during automatic class name conflict resolution during XML code generation; default to "" unless a value is specified.
    
    Returns:
    
    The type suffix to be inserted between element name and type name
  - setJavaNaming
```
public void setJavaNaming(JavaNaming javaNaming)
```
    To set the JavaNaming implementation to be used.
    
    Parameters:
    
    javaNaming - JavaNaming implementation to be used
    
    Since:
    
    1.1.3
  - getJavaNaming
```
public JavaNaming getJavaNaming()
```
    To get the JavaNaming implementation to be used.
    
    Returns:
    
    JavaNaming implementation to be used
    
    Since:
    
    1.1.3
  - addAnnotationBuilder
```
public void addAnnotationBuilder(AnnotationBuilder annotationBuilder)
```
    adds a custom annotation builder.
    
    Parameters:
    
    annotationBuilder - the builder
  - getAnnotationBuilders
```
public AnnotationBuilder[] getAnnotationBuilders()
```
    returns all applied annotation builders.
    
    Returns:
    
    a array of builders for type convenience
  - loadProperties
```
public static Properties loadProperties(String resourceName,
                                        String fileName)
```
    Load the configuration 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.
    
    Parameters:
    
    resourceName - Name of the source.
    
    fileName - Name of the configuration file.
    
    Returns:
    
    A Properties instance holding the actual XML code generator configuration.
  - useOldFieldNaming
```
public boolean useOldFieldNaming()
```

Class BuilderConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BuilderConfiguration

Method Detail

getDefault

getProperty

boundPropertiesEnabled

equalsMethod

setEqualsMethod

classDescFieldNames

generateExtraCollectionMethods

setClassDescFieldNames

usePrimitiveWrapper

setPrimitiveWrapper

useEnumeratedTypeInterface

useJava50

useJava5Enums

forceUseJava50

generateExtraDocumentationMethods

useCycleBreaker

getMaximumNumberOfConstants

setUseEnumeratedTypeInterface

mappingSchemaElement2Java

mappingSchemaType2Java

setDefaultProperties

setNamespacePackageMapping

setLocationPackageMapping

getJClassPrinterFactories

load

lookupPackageByNamespace

lookupPackageByLocation

processNamespacePackageMappings

isAutomaticConflictResolution

getAutomaticConflictResolutionTypeSuffix

setJavaNaming

getJavaNaming

addAnnotationBuilder

getAnnotationBuilders

loadProperties

useOldFieldNaming