|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.util.Configuration
org.exolab.castor.util.LocalConfiguration
public final class LocalConfiguration
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 |
---|
Nested classes/interfaces inherited from class org.exolab.castor.util.Configuration |
---|
Configuration.ConfigValues, Configuration.Features, Configuration.Property |
Field Summary |
---|
Fields inherited from class org.exolab.castor.util.Configuration |
---|
ON_VALUE, TRUE_VALUE |
Constructor Summary | |
---|---|
LocalConfiguration()
Creates a new instance of LocalConfiguration |
Method Summary | |
---|---|
boolean |
debug()
Returns true if the current configuration has enabled debugging. |
static LocalConfiguration |
getInstance()
Returns an instance of the LocalConfiguration, if a previous configuration has already been loaded for local resource, it will be returned. |
org.apache.xml.serialize.OutputFormat |
getOutputFormat()
Returns the default OutputFormat for use with a Serializer. |
org.xml.sax.Parser |
getParser()
Return an XML document parser implementing the feature list specified in the configuration file. |
org.xml.sax.Parser |
getParser(java.lang.String features)
Returns an XML document parser implementing the requested set of features. |
NodeType |
getPrimitiveNodeType()
Returns the NodeType to use for Java primitives. |
java.util.Properties |
getProperties()
Returns the current properties from the configuration file(s). |
RegExpEvaluator |
getRegExpEvaluator()
Returns a new instance of the specified Regular Expression Evaluator, or null if no validator was specified |
org.apache.xml.serialize.Serializer |
getSerializer()
Returns a default serializer for producing an XML document. |
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. |
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. |
XMLNaming |
getXMLNaming()
Returns the naming conventions to use for the XML framework |
org.xml.sax.XMLReader |
getXMLReader()
Returns an XML document parser implementing the requested set of features. |
org.xml.sax.XMLReader |
getXMLReader(java.lang.String features)
Returns an XML document parser implementing the requested set of features. |
protected void |
load()
Calls Configuration.getDefault() to load the configuration the
first time and then looks for a local configuration to
merge in with the defaults. |
void |
loadProperties(java.lang.String fileOrResourceName)
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. |
boolean |
marshallingValidation()
Returns true if the default configuration specified validation in the marshalling framework. |
boolean |
strictElements()
Access to the property specifying whether to apply strictness to elements when unmarshalling. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocalConfiguration()
Method Detail |
---|
public static LocalConfiguration getInstance()
public boolean debug()
debug
in class Configuration
Configuration.getDefaultDebug()
public boolean strictElements()
strictElements
in class Configuration
Configuration.getDefaultStrictElements()
public boolean marshallingValidation()
marshallingValidation
in class Configuration
Configuration.getDefaultMarshallingValidation()
public java.util.Properties getProperties()
getProperties
in class Configuration
Configuration.getDefault()
public XMLNaming getXMLNaming()
getXMLNaming
in class Configuration
Configuration.getDefaultXMLNaming()
public org.xml.sax.Parser getParser()
getParser
in class Configuration
Configuration.getDefaultParser()
public org.xml.sax.Parser getParser(java.lang.String features)
features
- The requested feature list, null for the
defaults
public org.xml.sax.XMLReader getXMLReader()
getXMLReader
in class Configuration
public org.xml.sax.XMLReader getXMLReader(java.lang.String features)
public NodeType getPrimitiveNodeType()
getPrimitiveNodeType
in class Configuration
Configuration.getDefaultPrimitiveNodeType()
public RegExpEvaluator getRegExpEvaluator()
getRegExpEvaluator
in class Configuration
Configuration.getDefaultRegExpEvaluator()
public org.apache.xml.serialize.Serializer getSerializer()
getSerializer
in class Configuration
Configuration.getDefaultSerializer()
public org.apache.xml.serialize.OutputFormat getOutputFormat()
getOutputFormat
in class Configuration
Configuration.getDefaultOutputFormat()
public org.xml.sax.DocumentHandler getSerializer(java.io.OutputStream output) throws java.io.IOException
getSerializer
in class Configuration
output
- The output stream
java.io.IOException
public org.xml.sax.DocumentHandler getSerializer(java.io.Writer output) throws java.io.IOException
getSerializer
in class Configuration
output
- The output stream
java.io.IOException
protected void load()
Configuration.getDefault()
to load the configuration the
first time and then looks for a local configuration to
merge in with the defaults. Will not complain about inability
to load local 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 void loadProperties(java.lang.String fileOrResourceName) throws java.io.FileNotFoundException
java.io.FileNotFoundException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |