org.castor.xml

Class XMLConfiguration


public final class XMLConfiguration
extends Configuration

Castor configuration of XML modul.
Version:
$Id: Configuration.java,v 1.8 2006/03/08 17:25:52 jens Exp $
Author:
Ralf Joachim
Since:
1.1.3

Field Summary

static String
COLLECTION_HANDLERS_FOR_JAVA_11_OR_12
Property specifying which collections handlers should be used for Java 1.1 and Java 1.2 run-times.
static String
DEBUG
Property specifying whether to run in debug mode.
static String
JAVA_NAMING
Property specifying the 'type' of the Java naming conventions to use.
static String
LENIENT_ID_VALIDATION
Property specifying whether id/href validation should be lenient; defaults to false.
static String
LENIENT_INTROSPECTED_ELEMENT_STRICTNESS
Property specifying whether element strictness for introspected classes/elements should be lenient (aka allowed); defaults to true.
static String
LENIENT_SEQUENCE_ORDER
Property specifying whether sequence order validation should be lenient.
static String
LOAD_PACKAGE_MAPPING
Property specifying whether the ClassDescriptorResolver should (automatically) search for and consult with package mapping files (.castor.xml) to retrieve class descriptor information; on by default.
static String
MARSHALLING_VALIDATION
Property specifying whether to use validation in the Marshalling framework.
static String
NAMESPACES
Property specifying whether to support XML namespaces by default.
static String
NAMESPACE_PACKAGE_MAPPINGS
Property specifying XML namespace to Java package mappings.
static String
PARSER
Property specifying the class name of the SAX 1 XML parser to use.
static String
PARSER_FEATURES
Property specifying additional features for the XML parser.
static String
PARSER_FEATURES_DISABLED
Property specifying features to be disbaled on the underlying SAX parser.
static String
PARSER_VALIDATION
Property specifying whether to perform document validation by default.
static String
PRIMITIVE_NODE_TYPE
Property specifying the type of XML node to use for primitive values, either 'element' or 'attribute'.
static String
PROXY_INTERFACES
Property specifying whether or not to search for an proxy interface at marshalling.
static String
REG_EXP_CLASS_NAME
Property specifying the regular expression validator to use.
static String
SAVE_MAP_KEYS
Property specifying whether or not to save the "keys" of a Hashtable or Map during marshalling.
static String
SERIALIZER_FACTORY
Property specifying what factory to use for dealing with XML serializers.
static String
STRICT_ELEMENTS
Property specifying whether to apply strictness to elements when unmarshalling.
static String
USE_INDENTATION
Property specifying whether XML documents (as generated at marshalling) should use indentation or not.
static String
USE_INTROSPECTION
Property specifying if introspection should be used at class resolving.
static String
WRAP_COLLECTIONS_PROPERTY
The property name for enabling collection wrapping.
static String
XML_NAMING
Property specifying the 'type' of the XML naming conventions to use.

Constructor Summary

XMLConfiguration(Configuration parent)
Construct a configuration with given parent.

Method Summary

static Configuration
newInstance()
Factory method for a default XML configuration instance.
static Configuration
newInstance(ClassLoader app, ClassLoader domain)
Factory method for a XML configuration instance that uses the specified class loaders.

Methods inherited from class org.castor.core.util.Configuration

get, getApplicationClassLoader, getBoolean, getBoolean, getClass, getClassArray, getDomainClassLoader, getInteger, getInteger, getObject, getObjectArray, getString, getString, getStringArray, loadDefaultProperties, loadUserProperties, put, remove

Field Details

COLLECTION_HANDLERS_FOR_JAVA_11_OR_12

public static final String COLLECTION_HANDLERS_FOR_JAVA_11_OR_12
Property specifying which collections handlers should be used for Java 1.1 and Java 1.2 run-times.
 org.exolab.castor.mapping.collections
 

DEBUG

public static final String DEBUG
Property specifying whether to run in debug mode. Possible values: - false (default) - true
 org.exolab.castor.debug
 

JAVA_NAMING

public static final String JAVA_NAMING

LENIENT_ID_VALIDATION

public static final String LENIENT_ID_VALIDATION
Property specifying whether id/href validation should be lenient; defaults to false. Possible values: - false (default) - true
 org.exolab.castor.xml.lenient.id.validation=false
 
since 1.1

LENIENT_INTROSPECTED_ELEMENT_STRICTNESS

public static final String LENIENT_INTROSPECTED_ELEMENT_STRICTNESS
Property specifying whether element strictness for introspected classes/elements should be lenient (aka allowed); defaults to true. Possible values: - false - true (default)
 org.exolab.castor.xml.lenient.introspected.element.strictness=true
 
Since:
1.1.3

LENIENT_SEQUENCE_ORDER

public static final String LENIENT_SEQUENCE_ORDER
Property specifying whether sequence order validation should be lenient. Possible values - false (default) - true
 org.exolab.castor.xml.lenient.sequence.order=false
 
since 1.1

LOAD_PACKAGE_MAPPING

public static final String LOAD_PACKAGE_MAPPING
Property specifying whether the ClassDescriptorResolver should (automatically) search for and consult with package mapping files (.castor.xml) to retrieve class descriptor information; on by default. Possible values: - false - true (default)
 org.exolab.castor.xml.loadPackageMappings
 
Since:
1.0

MARSHALLING_VALIDATION

public static final String MARSHALLING_VALIDATION
Property specifying whether to use validation in the Marshalling framework. Possible values: - false - true (default)
 org.exolab.castor.marshalling.validation
 

NAMESPACES

public static final String NAMESPACES
Property specifying whether to support XML namespaces by default. Possible values: - false (default) - true
 org.exolab.castor.SAXParser.namespaces
 

NAMESPACE_PACKAGE_MAPPINGS

public static final String NAMESPACE_PACKAGE_MAPPINGS
Property specifying XML namespace to Java package mappings.
 org.exolab.castor.xml.nspackages
 

PARSER

public static final String PARSER
Property specifying the class name of the SAX 1 XML parser to use.
 org.exolab.castor.parser
 

PARSER_FEATURES

public static final String PARSER_FEATURES
Property specifying additional features for the XML parser. This value contains a comma separated list of features that might or might not be supported by the specified SAX parser.
 org.exolab.castor.sax.features
 

PARSER_FEATURES_DISABLED

public static final String PARSER_FEATURES_DISABLED
Property specifying features to be disbaled on the underlying SAX parser. This value contains a comma separated list of features to be disabled.
 org.exolab.castor.sax.features-to-disable
 

PARSER_VALIDATION

public static final String PARSER_VALIDATION
Property specifying whether to perform document validation by default. Possible values: - false (default) - true
 org.exolab.castor.SAXParser.validation
 

PRIMITIVE_NODE_TYPE

public static final String PRIMITIVE_NODE_TYPE
Property specifying the type of XML node to use for primitive values, either 'element' or 'attribute'. Possible values: - 'element' - 'attribute' (default)
 org.exolab.castor.xml.introspector.primitive.nodetype
 

PROXY_INTERFACES

public static final String PROXY_INTERFACES
Property specifying whether or not to search for an proxy interface at marshalling. If property is not empty the objects to be marshalled will be searched if they implement one of the given interface names. If the interface is implemented the superclass will be marshalled instead of the class itself.
 org.exolab.castor.xml.proxyInterfaces
 
Since:
1.1.3

REG_EXP_CLASS_NAME

public static final String REG_EXP_CLASS_NAME
Property specifying the regular expression validator to use. The specified class must implement org.exolab.castor.xml.validators.RegExpValidator Possible values: - A class name.
 org.exolab.castor.regexp
 

SAVE_MAP_KEYS

public static final String SAVE_MAP_KEYS
Property specifying whether or not to save the "keys" of a Hashtable or Map during marshalling. By default this is true. Backwards compatibility switch (for 0.9.5.2 users and earlier) Possible values: - false - true (default)
 org.exolab.castor.xml.saveMapKeys
 
Since:
0.9.5.3

SERIALIZER_FACTORY

public static final String SERIALIZER_FACTORY
Property specifying what factory to use for dealing with XML serializers. Possible value: - A class name
 org.exolab.castor.xml.serializer.factory
 
Since:
1.0

STRICT_ELEMENTS

public static final String STRICT_ELEMENTS
Property specifying whether to apply strictness to elements when unmarshalling. Default is true which means that elements appearing in the XML document, which cannot be mapped to a class, cause a SAXException to be thrown. If set to false, these 'unknown' elements are ignored. Possible values: - false - true (default)
 org.exolab.castor.strictelements
 

USE_INDENTATION

public static final String USE_INDENTATION
Property specifying whether XML documents (as generated at marshalling) should use indentation or not. Possible values: - false (default) - true
 org.exolab.castor.indent
 

USE_INTROSPECTION

public static final String USE_INTROSPECTION
Property specifying if introspection should be used at class resolving.
 org.castor.xml.class-resolver.use-introspection
 

WRAP_COLLECTIONS_PROPERTY

public static final String WRAP_COLLECTIONS_PROPERTY
The property name for enabling collection wrapping. The property controls whether or not collections (arrays, vectors, etc) should be wrapped in a container element. For example:
    <foos>
       <foo>foo1</foo>
       <foo>foo2</foo>
    </foos>

   instead of the default:

    <foos>foo1<foos>
    <foos>foo2</foos>

 
Use this property with a value of true or false in the castor.properties file org.exolab.castor.xml.introspector.wrapCollections=true -or- org.exolab.castor.xml.introspector.wrapCollections=false This property is false by default.

XML_NAMING

public static final String XML_NAMING

Constructor Details

XMLConfiguration

public XMLConfiguration(Configuration parent)
Construct a configuration with given parent. Application and domain class loaders will be initialized to the ones of the parent.
Note: This constructor is not intended for public use. Use one of the newInstance() methods instead.
Parameters:
parent - Parent configuration.

Method Details

newInstance

public static Configuration newInstance()
Factory method for a default XML configuration instance. Application and domain class loaders will be initialized to the one used to load the Configuration class. The configuration instance returned will be a CastorConfiguration with a XMLConfiguration and a CoreConfiguration instance as parents. The CastorConfiguration holding user specific properties is the only one that can be modified by put() and remove() methods. XMLConfiguration and CoreConfiguration are responsble to deliver Castor's default values if they have not been overwritten by the user.
Returns:
Configuration instance for Castor XML modul.

newInstance

public static Configuration newInstance(ClassLoader app,
                                        ClassLoader domain)
Factory method for a XML configuration instance that uses the specified class loaders. The configuration instance returned will be a CastorConfiguration with a XMLConfiguration and a CoreConfiguration instance as parents. The CastorConfiguration holding user specific properties is the only one that can be modified by put() and remove() methods. XMLConfiguration and CoreConfiguration are responsble to deliver Castor's default values if they have not been overwritten by the user.
Parameters:
app - Classloader to be used for all classes of Castor and its required libraries.
domain - Classloader to be used for all domain objects.
Returns:
Configuration instance for Castor XML modul.

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