|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.util.Configuration
Provides default configuration for Castor components from the castor.properties configuration file. All Castor features rely on the central configuration file.
The configuration file is loaded from the Java lib directory, the classpath and the Castor JAR. Properties set in the classpath file takes precedence over properties set in the Java library configuration file and properties set in the Castor JAR, allowing for each customization. All three files are named castor.properties.
For example, to change the parser in use, specify that all documents should be printed with identantion or turn debugging on, create a new configuration file in the current directory, instead of modifying the global one.
Nested Class Summary | |
static class |
Configuration.Property
Names of properties used in the configuration file. |
Constructor Summary | |
Configuration()
|
Method Summary | |
static boolean |
debug()
Returns true if the default configuration specified debugging. |
static java.util.Properties |
getDefault()
Returns the default configuration file. |
static org.apache.xml.serialize.OutputFormat |
getOutputFormat()
Returns the default OutputFormat for use with a Serializer. |
static org.xml.sax.Parser |
getParser()
Return an XML document parser implementing the feature list specified in the configuration file. |
static org.xml.sax.Parser |
getParser(java.lang.String features)
Returns an XML document parser implementing the requested set of features. |
static NodeType |
getPrimitiveNodeType()
Returns the NodeType to use for Java primitives. |
static java.lang.String |
getProperty(java.lang.String name,
java.lang.String defValue)
Returns a property from the default configuration file. |
static RegExpEvaluator |
getRegExpEvaluator()
Returns a new instance of the specified Regular Expression Evaluator, or null if no validator was specified |
static org.apache.xml.serialize.Serializer |
getSerializer()
Returns a default serializer for producing an XML document. |
static org.xml.sax.DocumentHandler |
getSerializer(java.io.OutputStream output)
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format. |
static org.xml.sax.DocumentHandler |
getSerializer(java.io.Writer output)
Returns a default serializer for producing an XML document to the designated output stream using the default serialization format. |
static XMLNaming |
getXMLNaming()
Returns the naming conventions to use for the XML framework |
protected static void |
load()
Called by getDefault() to load the configuration the
first time. |
static java.util.Properties |
loadProperties(java.lang.String resourceName,
java.lang.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. |
static boolean |
marshallingValidation()
Returns true if the default configuration specified validation in the marshalling framework. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Configuration()
Method Detail |
public static boolean debug()
public static boolean marshallingValidation()
public static java.util.Properties getDefault()
public static java.lang.String getProperty(java.lang.String name, java.lang.String defValue)
getDefault()
.
name
- The property name
public static XMLNaming getXMLNaming()
public static org.xml.sax.Parser getParser()
public static org.xml.sax.Parser getParser(java.lang.String features)
features
- The requested feature list, null for the
defaults
public static NodeType getPrimitiveNodeType()
public static RegExpEvaluator getRegExpEvaluator()
public static org.apache.xml.serialize.Serializer getSerializer()
public static org.apache.xml.serialize.OutputFormat getOutputFormat()
public static org.xml.sax.DocumentHandler getSerializer(java.io.OutputStream output) throws java.io.IOException
output
- The output stream
java.io.IOException
public static org.xml.sax.DocumentHandler getSerializer(java.io.Writer output) throws java.io.IOException
output
- The output stream
java.io.IOException
protected static void load()
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.
public static java.util.Properties loadProperties(java.lang.String resourceName, java.lang.String fileName)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |