Class Digester
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
A Digester processes an XML input stream by matching a series of element nesting patterns to execute Rules that have been added prior to the start of parsing.
See the Digester Developer Guide for more information.
IMPLEMENTATION NOTE - A single Digester instance may only be used within the context of a single
thread at a time, and a call to parse()
must be completed before another can be initiated even from the
same thread.
A Digester instance should not be used for parsing more than one input document. The problem is that the Digester class has quite a few member variables whose values "evolve" as SAX events are received during a parse. When reusing the Digester instance, all these members must be reset back to their initial states before the second parse begins. The "clear()" method makes a stab at resetting these, but it is actually rather a difficult problem. If you are determined to reuse Digester instances, then at the least you should call the clear() method before each parse, and must call it if the Digester parse terminates due to an exception during a parse.
LEGACY IMPLEMENTATION NOTE - When using the legacy XML schema support (instead of using the
Schema
class), a bug in Xerces 2.0.2 prevents the support of XML schema. You need Xerces 2.1/2.3 and up to
make this class work with the legacy XML schema support.
This package was inspired by the XmlMapper
class that was part of Tomcat 3.0 and 3.1, but is organized
somewhat differently.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StringBuilder
The body text of the current element.private final Stack
<StringBuilder> The stack of body text string buffers for surrounding elements.private ClassLoader
The class loader to use for instantiating application objects.private boolean
Has this Digester been configured yet.private ContentHandler
If not null, then calls by the parser to this object's characters, startElement, endElement and processingInstruction methods are forwarded to the specified object.private EntityResolver
The EntityResolver used by the SAX parser.The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.private ErrorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.private ExecutorService
The executor service to run asynchronous parse method.private SAXParserFactory
The SAXParserFactory that is created the first time we need it.protected List
<InputSource> List
ofInputSource
instances created by acreateInputSourceFromURL()
method call.private Locator
The Locator associated with our parser.private org.apache.commons.logging.Log
The Log to which most logging calls will be made.private String
The current match pattern for nested element processing.Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().private boolean
Do we want a "namespace aware" parser.Registered namespaces we are currently processing.The parameters stack being utilized by CallMethodRule and CallParamRule rules.private SAXParser
The SAXParser we will use to parse the input stream.private String
The public identifier of the DTD we are currently parsing under (if any).private XMLReader
The XMLReader used to parse digester rules.private Object
The "root" element of the stack (in other words, the last object that was popped.private Rules
TheRules
implementation containing our collection ofRule
instances and associated matching policy.private org.apache.commons.logging.Log
The Log to which all SAX event related logging calls will be made.private Schema
The XML schema to use for validating an XML instance.The object stack being constructed.private StackAction
Object which will receive callbacks for every pop/push action on the default stack or named stacks.Stacks used for interrule communication, indexed by name Stringprivate Substitutor
An optional class that substitutes values in attributes and body text.private boolean
Do we want to use the Context ClassLoader when loading classes for instantiating new objects.private boolean
Do we want to use a validating parser.protected static final String
The schema language supported.private boolean
Do we want a "XInclude aware" parser. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBeanPropertySetter
(String pattern) Add a "bean property setter" rule for the specified parameters.void
addBeanPropertySetter
(String pattern, String propertyName) Add a "bean property setter" rule for the specified parameters.void
addCallMethod
(String pattern, String methodName) Add an "call method" rule for a method which accepts no arguments.void
addCallMethod
(String pattern, String methodName, int paramCount) Add an "call method" rule for the specified parameters.void
addCallMethod
(String pattern, String methodName, int paramCount, Class<?>[] paramTypes) Add an "call method" rule for the specified parameters.void
addCallMethod
(String pattern, String methodName, int paramCount, String[] paramTypes) Add an "call method" rule for the specified parameters.void
addCallParam
(String pattern, int paramIndex) Add a "call parameter" rule for the specified parameters.void
addCallParam
(String pattern, int paramIndex, boolean fromStack) Add a "call parameter" rule.void
addCallParam
(String pattern, int paramIndex, int stackIndex) Add a "call parameter" rule that sets a parameter from the stack.void
addCallParam
(String pattern, int paramIndex, String attributeName) Add a "call parameter" rule for the specified parameters.void
addCallParamPath
(String pattern, int paramIndex) Add a "call parameter" rule that sets a parameter from the currentDigester
matching path.void
addFactoryCreate
(String pattern, Class<? extends ObjectCreationFactory<?>> clazz) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, String attributeName) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, String attributeName, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, String className) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, String className, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, String className, String attributeName) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, String className, String attributeName, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, ObjectCreationFactory<?> creationFactory) Add a "factory create" rule for the specified parameters.void
addFactoryCreate
(String pattern, ObjectCreationFactory<?> creationFactory, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.void
addObjectCreate
(String pattern, Class<?> clazz) Add an "object create" rule for the specified parameters.void
addObjectCreate
(String pattern, String className) Add an "object create" rule for the specified parameters.void
addObjectCreate
(String pattern, String attributeName, Class<?> clazz) Add an "object create" rule for the specified parameters.void
addObjectCreate
(String pattern, String className, String attributeName) Add an "object create" rule for the specified parameters.void
addObjectParam
(String pattern, int paramIndex, Object paramObj) Add a "call parameter" rule that sets a parameter from a caller-provided object.void
Register a new Rule matching the specified pattern.void
addRuleSet
(RuleSet ruleSet) Register a set of Rule instances defined in a RuleSet.void
addSetNestedProperties
(String pattern) Adds anSetNestedPropertiesRule
.void
addSetNestedProperties
(String pattern, String[] elementNames, String[] propertyNames) Adds anSetNestedPropertiesRule
.void
addSetNestedProperties
(String pattern, String elementName, String propertyName) Adds anSetNestedPropertiesRule
.void
addSetNext
(String pattern, String methodName) Add a "set next" rule for the specified parameters.void
addSetNext
(String pattern, String methodName, String paramType) Add a "set next" rule for the specified parameters.void
addSetProperties
(String pattern) Add a "set properties" rule for the specified parameters.void
addSetProperties
(String pattern, String[] attributeNames, String[] propertyNames) Add a "set properties" rule with overridden parameters.void
addSetProperties
(String pattern, String attributeName, String propertyName) Add a "set properties" rule with a single overridden parameter.void
addSetProperty
(String pattern, String name, String value) Add a "set property" rule for the specified parameters.void
addSetRoot
(String pattern, String methodName) AddSetRootRule
with the specified parameters.void
addSetRoot
(String pattern, String methodName, String paramType) AddSetRootRule
with the specified parameters.void
Add a "set top" rule for the specified parameters.void
Add a "set top" rule for the specified parameters.<T> Future
<T> asyncParse
(File file) Creates a Callable instance that parse the content of the specified reader using this Digester.<T> Future
<T> asyncParse
(InputStream input) Creates a Callable instance that parse the content of the specified reader using this Digester.<T> Future
<T> asyncParse
(Reader reader) Creates a Callable instance that parse the content of the specified reader using this Digester.<T> Future
<T> asyncParse
(String uri) Creates a Callable instance that parse the content of the specified reader using this Digester.<T> Future
<T> asyncParse
(URL url) Creates a Callable instance that parse the content of the specified reader using this Digester.private <T> Future
<T> asyncParse
(Callable<T> callable) Execute the parse in async mode.<T> Future
<T> asyncParse
(InputSource input) Creates a Callable instance that parse the content of the specified reader using this Digester.void
characters
(char[] buffer, int start, int length) protected void
cleanup()
Clean up allocated resources after parsing is complete.void
clear()
Clear the current contents of the default object stack, the param stack, all named stacks, and other internal variables.protected void
Provide a hook for lazy configuration of thisDigester
instance.Convenience method that creates anInputSource
from the string version of a URL.Given a URL, return an InputSource that reads from that URL.Create a SAX exception which also understands about the location in the digester file where the exception occurscreateSAXException
(String message) Create a SAX exception which also understands about the location in the digester file where the exception occurscreateSAXException
(String message, Exception e) Create a SAX exception which also understands about the location in the digester file where the exception occursvoid
void
endElement
(String namespaceURI, String localName, String qName) void
endPrefixMapping
(String prefix) void
error
(SAXParseException exception) void
fatalError
(SAXParseException exception) findNamespaceURI
(String prefix) Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull
.Return the class loader to be used for instantiating application objects when required.int
getCount()
Return the current depth of the element stack.Return the name of the XML element that is currently being processed.Get the most current namespaces for all prefixes.returns the custom SAX ContentHandler where events are redirected.Gets the document locator associated with our parser.Return the Entity Resolver used by the SAX parser.Return the error handler for this Digester.Returns the executor service used to run asynchronous parse method.Return the SAXParserFactory we will use, creating one if necessary.boolean
getFeature
(String feature) Returns a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
.org.apache.commons.logging.Log
Return the current Logger associated with this instance of the DigestergetMatch()
Return the current rule match pathReturn a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().boolean
Return the "namespace aware" flag for parsers we create.Return the SAXParser we will use to parse the input stream.getProperty
(String property) Return the current value of the specified property for the underlyingXMLReader
implementation.Return the public identifier of the DTD we are currently parsing under, if any.Return the set of DTD URL registrations, keyed by public identifier.<T> T
getRoot()
Returns the root element of the tree of objects created as a result of applying the rule objects to the input XML.Return the namespace URI that will be applied to all subsequently addedRule
objects.getRules()
Return theRules
implementation object containing our rules collection and associated matching policy.org.apache.commons.logging.Log
Gets the logger used for logging SAX-related information.Return the callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.Gets theSubstitutor
used to convert attributes and body text.boolean
Return the boolean as to whether the context ClassLoader should be used.boolean
Return the validating parser flag.boolean
Return the XInclude-aware flag for parsers we create.Return the XMLReader to be used for parsing the input document.Return the XML Schema used when parsing.void
ignorableWhitespace
(char[] buffer, int start, int len) protected void
Provides a hook for lazy initialization of thisDigester
instance.boolean
Checks the Digester instance has been configured.boolean
Is the stack with the given name empty?void
notationDecl
(String name, String publicId, String systemId) private <T> T
npeSafeCast
(Object obj) Helps casting the input object to given type, avoiding NPEs.<T> T
Parse the content of the specified file using this Digester.<T> T
parse
(InputStream input) Parse the content of the specified input stream using this Digester.<T> T
Parse the content of the specified reader using this Digester.<T> T
Parse the content of the specified URI using this Digester.<T> T
Parse the content of the specified URL using this Digester.<T> T
parse
(InputSource input) Parse the content of the specified input source using this Digester.<T> T
peek()
Return the top object on the stack without removing it.<T> T
peek
(int n) Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element.<T> T
Gets the top object from the stack with the given name.<T> T
Gets the top object from the stack with the given name.Object[]
Return the top object on the parameters stack without removing it.Object[]
peekParams
(int n) Return the n'th object down the parameters stack, where 0 is the top element and [getCount()-1] is the bottom element.<T> T
pop()
Pop the top object off of the stack, and return it.<T> T
Pops (gets and removes) the top object from the stack with the given name.Object[]
Pop the top object off of the parameters stack, and return it.void
processingInstruction
(String target, String data) <T> void
Pushes the given object onto the stack with the given name.<T> void
push
(T object) Push a new object onto the top of the object stack.void
pushParams
(Object... object) Push a new object onto the top of the parameters stack.void
Convenience method that registers the string version of an entity URL instead of a URL version.void
Register the specified DTD URL for the specified public identifier.void
registerAll
(Map<String, URL> entityValidator) Convenience method that registers DTD URLs for the specified public identifiers.void
This method allows the "root" variable to be reset to null.resolveEntity
(String publicId, String systemId) void
setClassLoader
(ClassLoader classLoader) Set the class loader to be used for instantiating application objects when required.void
setCustomContentHandler
(ContentHandler handler) Redirects (or cancels redirecting) of SAX ContentHandler events to an external object.void
setDocumentLocator
(Locator locator) void
setEntityResolver
(EntityResolver entityResolver) Set theEntityResolver
used by SAX when resolving public id and system id.void
setErrorHandler
(ErrorHandler errorHandler) Set the error handler for this Digester.void
setExecutorService
(ExecutorService executorService) Sets the executor service to run asynchronous parse method.void
setFeature
(String feature, boolean value) Sets a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
.void
setLogger
(org.apache.commons.logging.Log log) Set the current logger for this Digester.void
setNamespaceAware
(boolean namespaceAware) Set the "namespace aware" flag for parsers we create.void
setProperty
(String property, Object value) Set the current value of the specified property for the underlyingXMLReader
implementation.void
setPublicId
(String publicId) Set the public id of the current file being parse.void
setRuleNamespaceURI
(String ruleNamespaceURI) Set the namespace URI that will be applied to all subsequently addedRule
objects.void
Set theRules
implementation object containing our rules collection and associated matching policy.void
setSAXLogger
(org.apache.commons.logging.Log saxLog) Sets the logger used for logging SAX-related information.void
setStackAction
(StackAction stackAction) Define a callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.void
setSubstitutor
(Substitutor substitutor) Sets theSubstitutor
to be used to convert attributes and body text.void
setUseContextClassLoader
(boolean use) Determine whether to use the Context ClassLoader (the one found by callingThread.currentThread().getContextClassLoader()
) to resolve/load classes that are defined in various rules.void
setValidating
(boolean validating) Set the validating parser flag.void
setXIncludeAware
(boolean xincludeAware) Set the XInclude-aware flag for parsers we create.void
setXMLSchema
(Schema schema) Set the XML Schema to be used when parsing.void
skippedEntity
(String name) void
void
startElement
(String namespaceURI, String localName, String qName, Attributes list) void
startPrefixMapping
(String prefix, String namespaceURI) void
unparsedEntityDecl
(String name, String publicId, String systemId, String notation) void
warning
(SAXParseException exception)
-
Field Details
-
bodyText
The body text of the current element. -
bodyTexts
The stack of body text string buffers for surrounding elements. -
matches
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch(). As each xml element in the input is entered, the matching rules are pushed onto this stack. After the end tag is reached, the matches are popped again. The depth of is stack is therefore exactly the same as the current "nesting" level of the input xml.- Since:
- 1.6
-
classLoader
The class loader to use for instantiating application objects. If not specified, the context class loader, or the class loader used to load Digester itself, is used, based on the value of theuseContextClassLoader
variable. -
configured
private boolean configuredHas this Digester been configured yet. -
entityResolver
The EntityResolver used by the SAX parser. By default it use this class -
entityValidator
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds. -
errorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur. -
factory
The SAXParserFactory that is created the first time we need it. -
locator
The Locator associated with our parser. -
match
The current match pattern for nested element processing. -
namespaceAware
private boolean namespaceAwareDo we want a "namespace aware" parser. -
executorService
The executor service to run asynchronous parse method.- Since:
- 3.1
-
namespaces
Registered namespaces we are currently processing. The key is the namespace prefix that was declared in the document. The value is an Stack of the namespace URIs this prefix has been mapped to -- the top Stack element is the most current one. (This architecture is required because documents can declare nested uses of the same prefix for different Namespace URIs). -
xincludeAware
private boolean xincludeAwareDo we want a "XInclude aware" parser. -
params
The parameters stack being utilized by CallMethodRule and CallParamRule rules.- Since:
- 2.0
-
parser
The SAXParser we will use to parse the input stream. -
publicId
The public identifier of the DTD we are currently parsing under (if any). -
reader
The XMLReader used to parse digester rules. -
root
The "root" element of the stack (in other words, the last object that was popped. -
rules
TheRules
implementation containing our collection ofRule
instances and associated matching policy. If not established before the first rule is added, a default implementation will be provided. -
schema
The XML schema to use for validating an XML instance.- Since:
- 2.0
-
stack
The object stack being constructed. -
useContextClassLoader
private boolean useContextClassLoaderDo we want to use the Context ClassLoader when loading classes for instantiating new objects. Default istrue
. -
validating
private boolean validatingDo we want to use a validating parser. -
log
private org.apache.commons.logging.Log logThe Log to which most logging calls will be made. -
saxLog
private org.apache.commons.logging.Log saxLogThe Log to which all SAX event related logging calls will be made. -
W3C_XML_SCHEMA
The schema language supported. By default, we use this one.- See Also:
-
substitutor
An optional class that substitutes values in attributes and body text. This may be null and so a null check is always required before use. -
stacksByName
Stacks used for interrule communication, indexed by name String -
customContentHandler
If not null, then calls by the parser to this object's characters, startElement, endElement and processingInstruction methods are forwarded to the specified object. This is intended to allow rules to temporarily "take control" of the sax events. In particular, this is used by NodeCreateRule.See setCustomContentHandler.
-
stackAction
Object which will receive callbacks for every pop/push action on the default stack or named stacks. -
inputSources
List
ofInputSource
instances created by acreateInputSourceFromURL()
method call. These represent open input streams that need to be closed to avoid resource leaks, as well as potentially locked JAR files on Windows.
-
-
Constructor Details
-
Digester
public Digester()Construct a new Digester with default properties. -
Digester
Construct a new Digester, allowing a SAXParser to be passed in. This allows Digester to be used in environments which are unfriendly to JAXP1.1 (such as WebLogic 6.0). This may help in places where you are able to load JAXP 1.1 classes yourself.- Parameters:
parser
- The SAXParser used to parse XML streams
-
Digester
Construct a new Digester, allowing an XMLReader to be passed in. This allows Digester to be used in environments which are unfriendly to JAXP1.1 (such as WebLogic 6.0). Note that if you use this option you have to configure namespace and validation support yourself, as these properties only affect the SAXParser and emtpy constructor.- Parameters:
reader
- The XMLReader used to parse XML streams
-
-
Method Details
-
findNamespaceURI
Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull
. These mappings come and go dynamically as the document is parsed.- Parameters:
prefix
- Prefix to look up- Returns:
- the currently mapped namespace URI for the specified prefix
-
getClassLoader
Return the class loader to be used for instantiating application objects when required. This is determined based upon the following rules:- The class loader set by
setClassLoader()
, if any - The thread context class loader, if it exists and the
useContextClassLoader
property is set to true - The class loader used to load the Digester class itself.
- Returns:
- the class loader to be used for instantiating application objects.
- The class loader set by
-
setClassLoader
Set the class loader to be used for instantiating application objects when required.- Parameters:
classLoader
- The new class loader to use, ornull
to revert to the standard rules
-
getCount
public int getCount()Return the current depth of the element stack.- Returns:
- the current depth of the element stack.
-
getCurrentElementName
Return the name of the XML element that is currently being processed.- Returns:
- the name of the XML element that is currently being processed.
-
getErrorHandler
Return the error handler for this Digester.- Returns:
- the error handler for this Digester.
-
setErrorHandler
Set the error handler for this Digester.- Parameters:
errorHandler
- The new error handler
-
getFactory
Return the SAXParserFactory we will use, creating one if necessary.- Returns:
- the SAXParserFactory we will use, creating one if necessary.
-
getFeature
public boolean getFeature(String feature) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException Returns a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
. See the saxproject website for information about the standard SAX2 feature flags.- Parameters:
feature
- Name of the feature to inquire about- Returns:
- true, if the requested feature is supported by the underlying implementation of
org.xml.sax.XMLReader
, false otherwise - Throws:
ParserConfigurationException
- if a parser configuration error occursSAXNotRecognizedException
- if the property name is not recognizedSAXNotSupportedException
- if the property name is recognized but not supported
-
setFeature
public void setFeature(String feature, boolean value) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException Sets a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
. See the saxproject website for information about the standard SAX2 feature flags. In order to be effective, this method must be called before thegetParser()
method is called for the first time, either directly or indirectly.- Parameters:
feature
- Name of the feature to set the status forvalue
- The new value for this feature- Throws:
ParserConfigurationException
- if a parser configuration error occursSAXNotRecognizedException
- if the property name is not recognizedSAXNotSupportedException
- if the property name is recognized but not supported
-
getLogger
public org.apache.commons.logging.Log getLogger()Return the current Logger associated with this instance of the Digester- Returns:
- the current Logger associated with this instance of the Digester
-
setLogger
public void setLogger(org.apache.commons.logging.Log log) Set the current logger for this Digester.- Parameters:
log
- the current logger for this Digester.
-
getSAXLogger
public org.apache.commons.logging.Log getSAXLogger()Gets the logger used for logging SAX-related information. Note the output is finely grained.- Returns:
- the logger used for logging SAX-related information
- Since:
- 1.6
-
setSAXLogger
public void setSAXLogger(org.apache.commons.logging.Log saxLog) Sets the logger used for logging SAX-related information. Note the output is finely grained.- Parameters:
saxLog
- the logger used for logging SAX-related information, not null- Since:
- 1.6
-
getMatch
Return the current rule match path- Returns:
- the current rule match path
-
getMatches
Return a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().- Returns:
- a Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().
- Since:
- 3.0
-
getNamespaceAware
public boolean getNamespaceAware()Return the "namespace aware" flag for parsers we create.- Returns:
- the "namespace aware" flag for parsers we create.
-
setNamespaceAware
public void setNamespaceAware(boolean namespaceAware) Set the "namespace aware" flag for parsers we create.- Parameters:
namespaceAware
- The new "namespace aware" flag
-
getXIncludeAware
public boolean getXIncludeAware()Return the XInclude-aware flag for parsers we create. XInclude functionality additionally requires namespace-awareness.- Returns:
- The XInclude-aware flag
- Since:
- 2.0
- See Also:
-
setXIncludeAware
public void setXIncludeAware(boolean xincludeAware) Set the XInclude-aware flag for parsers we create. This additionally requires namespace-awareness.- Parameters:
xincludeAware
- The new XInclude-aware flag- Since:
- 2.0
- See Also:
-
setPublicId
Set the public id of the current file being parse.- Parameters:
publicId
- the DTD/Schema public's id.
-
getPublicId
Return the public identifier of the DTD we are currently parsing under, if any.- Returns:
- the public identifier of the DTD we are currently parsing under, if any.
-
getRuleNamespaceURI
Return the namespace URI that will be applied to all subsequently addedRule
objects.- Returns:
- the namespace URI that will be applied to all subsequently added
Rule
objects.
-
setRuleNamespaceURI
Set the namespace URI that will be applied to all subsequently addedRule
objects.- Parameters:
ruleNamespaceURI
- Namespace URI that must match on all subsequently added rules, ornull
for matching regardless of the current namespace URI
-
getParser
Return the SAXParser we will use to parse the input stream. If there is a problem creating the parser, returnnull
.- Returns:
- the SAXParser we will use to parse the input stream
-
getProperty
public Object getProperty(String property) throws SAXNotRecognizedException, SAXNotSupportedException Return the current value of the specified property for the underlyingXMLReader
implementation. See the saxproject website for information about the standard SAX2 properties.- Parameters:
property
- Property name to be retrieved- Returns:
- the current value of the specified property for the underlying
XMLReader
implementation. - Throws:
SAXNotRecognizedException
- if the property name is not recognizedSAXNotSupportedException
- if the property name is recognized but not supported
-
setProperty
public void setProperty(String property, Object value) throws SAXNotRecognizedException, SAXNotSupportedException Set the current value of the specified property for the underlyingXMLReader
implementation. See the saxproject website for information about the standard SAX2 properties.- Parameters:
property
- Property name to be setvalue
- Property value to be set- Throws:
SAXNotRecognizedException
- if the property name is not recognizedSAXNotSupportedException
- if the property name is recognized but not supported
-
getRules
Return theRules
implementation object containing our rules collection and associated matching policy. If none has been established, a default implementation will be created and returned.- Returns:
- the
Rules
implementation object.
-
setRules
Set theRules
implementation object containing our rules collection and associated matching policy.- Parameters:
rules
- New Rules implementation
-
getXMLSchema
Return the XML Schema used when parsing.- Returns:
- The
Schema
instance in use. - Since:
- 2.0
-
setXMLSchema
Set the XML Schema to be used when parsing.- Parameters:
schema
- TheSchema
instance to use.- Since:
- 2.0
-
getUseContextClassLoader
public boolean getUseContextClassLoader()Return the boolean as to whether the context ClassLoader should be used.- Returns:
- true, if the context ClassLoader should be used, false otherwise.
-
setUseContextClassLoader
public void setUseContextClassLoader(boolean use) Determine whether to use the Context ClassLoader (the one found by callingThread.currentThread().getContextClassLoader()
) to resolve/load classes that are defined in various rules. If not using Context ClassLoader, then the class-loading defaults to using the calling-class' ClassLoader.- Parameters:
use
- determines whether to use Context ClassLoader.
-
getValidating
public boolean getValidating()Return the validating parser flag.- Returns:
- the validating parser flag.
-
setValidating
public void setValidating(boolean validating) Set the validating parser flag. This must be called beforeparse()
is called the first time.- Parameters:
validating
- The new validating parser flag.
-
getXMLReader
Return the XMLReader to be used for parsing the input document. FIXME: there is a bug in JAXP/XERCES that prevent the use of a parser that contains a schema with a DTD.- Returns:
- the XMLReader to be used for parsing the input document.
- Throws:
SAXException
- if no XMLReader can be instantiated
-
getSubstitutor
Gets theSubstitutor
used to convert attributes and body text.- Returns:
- the
Substitutor
used to convert attributes and body text, null if not substitutions are to be performed.
-
setSubstitutor
Sets theSubstitutor
to be used to convert attributes and body text.- Parameters:
substitutor
- the Substitutor to be used to convert attributes and body text or null if not substitution of these values is to be performed.
-
getCustomContentHandler
returns the custom SAX ContentHandler where events are redirected.- Returns:
- the custom SAX ContentHandler where events are redirected.
- Since:
- 1.7
- See Also:
-
setCustomContentHandler
Redirects (or cancels redirecting) of SAX ContentHandler events to an external object.When this object's customContentHandler is non-null, any SAX events received from the parser will simply be passed on to the specified object instead of this object handling them. This allows Rule classes to take control of the SAX event stream for a while in order to do custom processing. Such a rule should save the old value before setting a new one, and restore the old value in order to resume normal digester processing.
An example of a Rule which needs this feature is NodeCreateRule.
Note that saving the old value is probably not needed as it should always be null; a custom rule that wants to take control could only have been called when there was no custom content handler. But it seems cleaner to properly save/restore the value and maybe some day this will come in useful.
Note also that this is not quite equivalent to
digester.getXMLReader().setContentHandler( handler )
for these reasons:- Some xml parsers don't like having setContentHandler called after parsing has started. The Aelfred parser is one example.
- Directing the events via the Digester object potentially allows us to log information about those SAX events at the digester level.
- Parameters:
handler
- the custom SAX ContentHandler where events are redirected.- Since:
- 1.7
-
setStackAction
Define a callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.- Parameters:
stackAction
- the callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.- Since:
- 1.8
-
getStackAction
Return the callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.- Returns:
- the callback object which is invoked whenever an object is pushed onto a digester object stack, or popped off one.
- Since:
- 1.8
- See Also:
-
getCurrentNamespaces
Get the most current namespaces for all prefixes.- Returns:
- Map A map with namespace prefixes as keys and most current namespace URIs for the corresponding prefixes as values
- Since:
- 1.8
-
getExecutorService
Returns the executor service used to run asynchronous parse method.- Returns:
- the executor service used to run asynchronous parse method
- Since:
- 3.1
-
setExecutorService
Sets the executor service to run asynchronous parse method.- Parameters:
executorService
- the executor service to run asynchronous parse method- Since:
- 3.1
-
characters
- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classDefaultHandler
- Throws:
SAXException
-
endDocument
- Specified by:
endDocument
in interfaceContentHandler
- Overrides:
endDocument
in classDefaultHandler
- Throws:
SAXException
-
endElement
- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classDefaultHandler
- Throws:
SAXException
-
endPrefixMapping
- Specified by:
endPrefixMapping
in interfaceContentHandler
- Overrides:
endPrefixMapping
in classDefaultHandler
- Throws:
SAXException
-
ignorableWhitespace
- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classDefaultHandler
- Throws:
SAXException
-
processingInstruction
- Specified by:
processingInstruction
in interfaceContentHandler
- Overrides:
processingInstruction
in classDefaultHandler
- Throws:
SAXException
-
getDocumentLocator
Gets the document locator associated with our parser.- Returns:
- the Locator supplied by the document parser
-
setDocumentLocator
- Specified by:
setDocumentLocator
in interfaceContentHandler
- Overrides:
setDocumentLocator
in classDefaultHandler
-
skippedEntity
- Specified by:
skippedEntity
in interfaceContentHandler
- Overrides:
skippedEntity
in classDefaultHandler
- Throws:
SAXException
-
startDocument
- Specified by:
startDocument
in interfaceContentHandler
- Overrides:
startDocument
in classDefaultHandler
- Throws:
SAXException
-
startElement
public void startElement(String namespaceURI, String localName, String qName, Attributes list) throws SAXException - Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classDefaultHandler
- Throws:
SAXException
-
startPrefixMapping
- Specified by:
startPrefixMapping
in interfaceContentHandler
- Overrides:
startPrefixMapping
in classDefaultHandler
- Throws:
SAXException
-
notationDecl
- Specified by:
notationDecl
in interfaceDTDHandler
- Overrides:
notationDecl
in classDefaultHandler
-
unparsedEntityDecl
- Specified by:
unparsedEntityDecl
in interfaceDTDHandler
- Overrides:
unparsedEntityDecl
in classDefaultHandler
-
setEntityResolver
Set theEntityResolver
used by SAX when resolving public id and system id. This must be called before the first call toparse()
.- Parameters:
entityResolver
- a class that implement theEntityResolver
interface.
-
getEntityResolver
Return the Entity Resolver used by the SAX parser.- Returns:
- the Entity Resolver used by the SAX parser.
-
resolveEntity
- Specified by:
resolveEntity
in interfaceEntityResolver
- Overrides:
resolveEntity
in classDefaultHandler
- Throws:
SAXException
-
error
- Specified by:
error
in interfaceErrorHandler
- Overrides:
error
in classDefaultHandler
- Throws:
SAXException
-
fatalError
- Specified by:
fatalError
in interfaceErrorHandler
- Overrides:
fatalError
in classDefaultHandler
- Throws:
SAXException
-
warning
- Specified by:
warning
in interfaceErrorHandler
- Overrides:
warning
in classDefaultHandler
- Throws:
SAXException
-
parse
Parse the content of the specified file using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
file
- File containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
file
- File containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
parse
Parse the content of the specified input source using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
input
- Input source containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
input
- Input source containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
parse
Parse the content of the specified input stream using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
input
- Input stream containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
input
- Input stream containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
parse
Parse the content of the specified reader using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
reader
- Reader containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
reader
- Reader containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
parse
Parse the content of the specified URI using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
uri
- URI containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
uri
- URI containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
parse
Parse the content of the specified URL using this Digester. Returns the root element from the object stack (if any).- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
url
- URL containing the XML data to be parsed- Returns:
- the root element from the object stack (if any)
- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs- Since:
- 1.8
-
asyncParse
Creates a Callable instance that parse the content of the specified reader using this Digester.- Type Parameters:
T
- The result type returned by the returned Future'sget
method- Parameters:
url
- URL containing the XML data to be parsed- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
- See Also:
-
asyncParse
Execute the parse in async mode.- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
callable
-- Returns:
- a Future that can be used to track when the parse has been fully processed.
- Since:
- 3.1
-
register
Register the specified DTD URL for the specified public identifier. This must be called before the first call to
parse()
.Digester
contains an internalEntityResolver
implementation. This mapsPUBLICID
's to URLs (from which the resource will be loaded). A common use case for this method is to register local URLs (possibly computed at runtime by a classloader) for DTDs. This allows the performance advantage of using a local version without having to ensure everySYSTEM
URI on every processed xml document is local. This implementation provides only basic functionality. If more sophisticated features are required, usingsetEntityResolver(org.xml.sax.EntityResolver)
to set a custom resolver is recommended.Note: This method will have no effect when a custom
EntityResolver
has been set. (Setting a customEntityResolver
overrides the internal implementation.)- Parameters:
publicId
- Public identifier of the DTD to be resolvedentityURL
- The URL to use for reading this DTD- Since:
- 1.8
-
register
Convenience method that registers the string version of an entity URL instead of a URL version.
- Parameters:
publicId
- Public identifier of the entity to be resolvedentityURL
- The URL to use for reading this entity
-
registerAll
Convenience method that registers DTD URLs for the specified public identifiers.- Parameters:
entityValidator
- The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.- Since:
- 3.0
-
createInputSourceFromURL
Given a URL, return an InputSource that reads from that URL.Ideally this function would not be needed and code could just use
new InputSource(entityURL)
. Unfortunately it appears that when the entityURL points to a file within a jar archive a caching mechanism inside the InputSource implementation causes a file-handle to the jar file to remain open. On Windows systems this then causes the jar archive file to be locked on disk ("in use") which makes it impossible to delete the jar file - and that really stuffs up "undeploy" in webapps in particular.In JDK1.4 and later, Apache XercesJ is used as the xml parser. The InputSource object provided is converted into an XMLInputSource, and eventually passed to an instance of XMLDocumentScannerImpl to specify the source data to be converted into tokens for the rest of the XMLReader code to handle. XMLDocumentScannerImpl calls fEntityManager.startDocumentEntity(source), where fEntityManager is declared in ancestor class XMLScanner to be an XMLEntityManager. In that class, if the input source stream is null, then:
URL location = new URL( expandedSystemId ); URLConnection connect = location.openConnection(); if ( connect instanceof HttpURLConnection ) { setHttpProperties( connect, xmlInputSource ); } stream = connect.getInputStream();
This method pretty much duplicates the standard behaviour, except that it calls URLConnection.setUseCaches(false) before opening the connection.- Parameters:
url
- The URL has to be read- Returns:
- The InputSource that reads from the input URL
- Throws:
IOException
- if any error occurs while reading the input URL- Since:
- 1.8
-
createInputSourceFromURL
Convenience method that creates an
InputSource
from the string version of a URL.- Parameters:
url
- URL for which to create anInputSource
- Returns:
- The InputSource that reads from the input URL
- Throws:
IOException
- if any error occurs while reading the input URL- Since:
- 1.8
-
addRule
Register a new Rule matching the specified pattern. This method sets the
Digester
property on the rule.- Parameters:
pattern
- Element matching patternrule
- Rule to be registered
-
addRuleSet
Register a set of Rule instances defined in a RuleSet.- Parameters:
ruleSet
- The RuleSet instance to configure from
-
addBeanPropertySetter
Add a "bean property setter" rule for the specified parameters.- Parameters:
pattern
- Element matching pattern- See Also:
-
addBeanPropertySetter
Add a "bean property setter" rule for the specified parameters.- Parameters:
pattern
- Element matching patternpropertyName
- Name of property to set- See Also:
-
addCallMethod
Add an "call method" rule for a method which accepts no arguments.- Parameters:
pattern
- Element matching patternmethodName
- Method name to be called- See Also:
-
addCallMethod
Add an "call method" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)- See Also:
-
addCallMethod
Add an "call method" rule for the specified parameters. IfparamCount
is set to zero the rule will use the body of the matched element as the single argument of the method, unlessparamTypes
is null or empty, in this case the rule will call the specified method with no arguments.- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)paramTypes
- Set of Java class names for the types of the expected parameters (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)- See Also:
-
addCallMethod
Add an "call method" rule for the specified parameters. IfparamCount
is set to zero the rule will use the body of the matched element as the single argument of the method, unlessparamTypes
is null or empty, in this case the rule will call the specified method with no arguments.- Parameters:
pattern
- Element matching patternmethodName
- Method name to be calledparamCount
- Number of expected parameters (or zero for a single parameter from the body of this element)paramTypes
- The Java class names of the arguments (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)- See Also:
-
addCallParam
Add a "call parameter" rule for the specified parameters.- Parameters:
pattern
- Element matching patternparamIndex
- Zero-relative parameter index to set (from the body of this element)- See Also:
-
addCallParam
Add a "call parameter" rule for the specified parameters.- Parameters:
pattern
- Element matching patternparamIndex
- Zero-relative parameter index to set (from the specified attribute)attributeName
- Attribute whose value is used as the parameter value- See Also:
-
addCallParam
Add a "call parameter" rule. This will either take a parameter from the stack or from the current element body text.- Parameters:
pattern
- Element matching patternparamIndex
- The zero-relative parameter numberfromStack
- Should the call parameter be taken from the top of the stack?- See Also:
-
addCallParam
Add a "call parameter" rule that sets a parameter from the stack. This takes a parameter from the given position on the stack.- Parameters:
pattern
- Element matching patternparamIndex
- The zero-relative parameter numberstackIndex
- set the call parameter to the stackIndex'th object down the stack, where 0 is the top of the stack, 1 the next element down and so on- See Also:
-
addCallParamPath
Add a "call parameter" rule that sets a parameter from the currentDigester
matching path. This is sometimes useful when using rules that support wildcards.- Parameters:
pattern
- the pattern that this rule should matchparamIndex
- The zero-relative parameter number- See Also:
-
addObjectParam
Add a "call parameter" rule that sets a parameter from a caller-provided object. This can be used to pass constants such as strings to methods; it can also be used to pass mutable objects, providing ways for objects to do things like "register" themselves with some shared object.Note that when attempting to locate a matching method to invoke, the true type of the paramObj is used, so that despite the paramObj being passed in here as type Object, the target method can declare its parameters as being the true type of the object (or some ancestor type, according to the usual type-conversion rules).
- Parameters:
pattern
- Element matching patternparamIndex
- The zero-relative parameter numberparamObj
- Any arbitrary object to be passed to the target method.- Since:
- 1.6
- See Also:
-
addFactoryCreate
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory class- See Also:
-
addFactoryCreate
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory class- See Also:
-
addFactoryCreate
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
- See Also:
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, String attributeName) Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
- See Also:
-
addFactoryCreate
Add a "factory create" rule for the specified parameters. Exceptions thrown during the object creation process will be propagated.- Parameters:
pattern
- Element matching patterncreationFactory
- Previously instantiated ObjectCreationFactory to be utilized- See Also:
-
addFactoryCreate
Add a "factory create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.- See Also:
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.- See Also:
-
addFactoryCreate
public void addFactoryCreate(String pattern, String className, String attributeName, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclassName
- Java class name of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
ignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.- See Also:
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<? extends ObjectCreationFactory<?>> clazz, String attributeName, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclazz
- Java class of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
ignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.- See Also:
-
addFactoryCreate
public void addFactoryCreate(String pattern, ObjectCreationFactory<?> creationFactory, boolean ignoreCreateExceptions) Add a "factory create" rule for the specified parameters.- Parameters:
pattern
- Element matching patterncreationFactory
- Previously instantiated ObjectCreationFactory to be utilizedignoreCreateExceptions
- whentrue
any exceptions thrown during object creation will be ignored.- See Also:
-
addObjectCreate
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclassName
- Java class name to be created- See Also:
-
addObjectCreate
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclazz
- Java class to be created- See Also:
-
addObjectCreate
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclassName
- Default Java class name to be createdattributeName
- Attribute name that optionally overrides the default Java class name to be created- See Also:
-
addObjectCreate
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternattributeName
- Attribute name that optionally overridesclazz
- Default Java class to be created the default Java class name to be created- See Also:
-
addSetNestedProperties
Adds anSetNestedPropertiesRule
.- Parameters:
pattern
- register the rule with this pattern- Since:
- 1.6
-
addSetNestedProperties
Adds anSetNestedPropertiesRule
.- Parameters:
pattern
- register the rule with this patternelementName
- elment name that a property maps topropertyName
- property name of the element mapped from- Since:
- 1.6
-
addSetNestedProperties
Adds anSetNestedPropertiesRule
.- Parameters:
pattern
- register the rule with this patternelementNames
- elment names that (in order) map to propertiespropertyNames
- property names that (in order) elements are mapped to- Since:
- 1.6
-
addSetNext
Add a "set next" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element- See Also:
-
addSetNext
Add a "set next" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent elementparamType
- Java class name of the expected parameter type (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)- See Also:
-
addSetRoot
AddSetRootRule
with the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the root object- See Also:
-
addSetRoot
AddSetRootRule
with the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the root objectparamType
- Java class name of the expected parameter type- See Also:
-
addSetProperties
Add a "set properties" rule for the specified parameters.- Parameters:
pattern
- Element matching pattern- See Also:
-
addSetProperties
Add a "set properties" rule with a single overridden parameter. SeeSetPropertiesRule(String attributeName, String propertyName)
- Parameters:
pattern
- Element matching patternattributeName
- map this attributepropertyName
- to this property- See Also:
-
addSetProperties
Add a "set properties" rule with overridden parameters. SeeSetPropertiesRule(String [] attributeNames, String [] propertyNames)
- Parameters:
pattern
- Element matching patternattributeNames
- names of attributes with custom mappingspropertyNames
- property names these attributes map to- See Also:
-
addSetProperty
Add a "set property" rule for the specified parameters.- Parameters:
pattern
- Element matching patternname
- Attribute name containing the property name to be setvalue
- Attribute name containing the property value to set- See Also:
-
addSetTop
Add a "set top" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element- See Also:
-
addSetTop
Add a "set top" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent elementparamType
- Java class name of the expected parameter type (if you wish to use a primitive type, specify the corresonding Java wrapper class instead, such asjava.lang.Boolean
for aboolean
parameter)- See Also:
-
clear
public void clear()Clear the current contents of the default object stack, the param stack, all named stacks, and other internal variables.Calling this method might allow another document of the same type to be correctly parsed. However this method was not intended for this purpose (just to tidy up memory usage). In general, a separate Digester object should be created for each document to be parsed.
Note that this method is called automatically after a document has been successfully parsed by a Digester instance. However it is not invoked automatically when a parse fails, so when reusing a Digester instance (which is not recommended) this method must be called manually after a parse failure.
-
peek
public <T> T peek()Return the top object on the stack without removing it. If there are no objects on the stack, returnnull
.- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Returns:
- the top object on the stack without removing it.
-
peek
public <T> T peek(int n) Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element. If the specified index is out of range, returnnull
.- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
n
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.- Returns:
- the n'th object down the stack
-
pop
public <T> T pop()Pop the top object off of the stack, and return it. If there are no objects on the stack, returnnull
.- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Returns:
- the top object popped off of the stack
-
push
public <T> void push(T object) Push a new object onto the top of the object stack.- Type Parameters:
T
- any type of the pushed object- Parameters:
object
- The new object
-
push
Pushes the given object onto the stack with the given name. If no stack already exists with the given name then one will be created.- Type Parameters:
T
- any type of the pushed object- Parameters:
stackName
- the name of the stack onto which the object should be pushedvalue
- the Object to be pushed onto the named stack.- Since:
- 1.6
-
pop
Pops (gets and removes) the top object from the stack with the given name.
Note: a stack is considered empty if no objects have been pushed onto it yet.
- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
stackName
- the name of the stack from which the top value is to be popped.- Returns:
- the top
Object
on the stack or or null if the stack is either empty or has not been created yet - Since:
- 1.6
-
peek
Gets the top object from the stack with the given name. This method does not remove the object from the stack.
Note: a stack is considered empty if no objects have been pushed onto it yet.
- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
stackName
- the name of the stack to be peeked- Returns:
- the top
Object
on the stack or null if the stack is either empty or has not been created yet - Since:
- 1.6
-
peek
Gets the top object from the stack with the given name. This method does not remove the object from the stack.
Note: a stack is considered empty if no objects have been pushed onto it yet.
- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Parameters:
stackName
- the name of the stack to be peekedn
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.- Returns:
- the specified
Object
on the stack. - Since:
- 1.6
-
isEmpty
Is the stack with the given name empty?
Note: a stack is considered empty if no objects have been pushed onto it yet.
- Parameters:
stackName
- the name of the stack whose emptiness should be evaluated- Returns:
- true if the given stack if empty
- Since:
- 1.6
-
getRoot
public <T> T getRoot()Returns the root element of the tree of objects created as a result of applying the rule objects to the input XML.If the digester stack was "primed" by explicitly pushing a root object onto the stack before parsing started, then that root object is returned here.
Alternatively, if a Rule which creates an object (eg ObjectCreateRule) matched the root element of the xml, then the object created will be returned here.
In other cases, the object most recently pushed onto an empty digester stack is returned. This would be a most unusual use of digester, however; one of the previous configurations is much more likely.
Note that when using one of the Digester.parse methods, the return value from the parse method is exactly the same as the return value from this method. However when the Digester is being used as a SAXContentHandler, no such return value is available; in this case, this method allows you to access the root object that has been created after parsing has completed.
- Type Parameters:
T
- the type used to auto-cast the returned object to the assigned variable type- Returns:
- the root object that has been created after parsing or null if the digester has not parsed any XML yet.
-
resetRoot
public void resetRoot()This method allows the "root" variable to be reset to null.It is not considered safe for a digester instance to be reused to parse multiple xml documents. However if you are determined to do so, then you should call both clear() and resetRoot() before each parse.
- Since:
- 1.7
-
cleanup
protected void cleanup()Clean up allocated resources after parsing is complete. The default method closes input streams that have been created by Digester itself. If you override this method in a subclass, be sure to call
super.cleanup()
to invoke this logic.- Since:
- 1.8
-
configure
protected void configure()Provide a hook for lazy configuration of this
Digester
instance. The default implementation does nothing, but subclasses can override as needed.Note This method may be called more than once. Once only initialization code should be placed in
initialize()
or the code should take responsibility by checking and setting theconfigured
flag. -
isConfigured
public boolean isConfigured()Checks the Digester instance has been configured.- Returns:
- true, if the Digester instance has been configured, false otherwise
- Since:
- 3.0
-
initialize
protected void initialize()Provides a hook for lazy initialization of this
Digester
instance. The default implementation does nothing, but subclasses can override as needed. Digester (by default) only calls this method once.Note This method will be called by
configure()
only when theconfigured
flag is false. Subclasses that overrideconfigure
or who setconfigured
may find that this method may be called more than once.- Since:
- 1.6
-
getRegistrations
Return the set of DTD URL registrations, keyed by public identifier. NOTE: the returned map is in read-only mode.- Returns:
- the read-only Map of DTD URL registrations.
-
peekParams
Return the top object on the parameters stack without removing it. If there are no objects on the stack, return
null
.The parameters stack is used to store
CallMethodRule
parameters. Seeparams
.- Returns:
- the top object on the parameters stack without removing it.
-
peekParams
Return the n'th object down the parameters stack, where 0 is the top element and [getCount()-1] is the bottom element. If the specified index is out of range, return
null
.The parameters stack is used to store
CallMethodRule
parameters. Seeparams
.- Parameters:
n
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.- Returns:
- the n'th object down the parameters stack
-
popParams
Pop the top object off of the parameters stack, and return it. If there are no objects on the stack, return
null
.The parameters stack is used to store
CallMethodRule
parameters. Seeparams
.- Returns:
- the top object popped off of the parameters stack
-
pushParams
Push a new object onto the top of the parameters stack.
The parameters stack is used to store
CallMethodRule
parameters. Seeparams
.- Parameters:
object
- The new object
-
createSAXException
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
message
- the custom SAX exception messagee
- the exception cause- Returns:
- the new SAX exception
-
createSAXException
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
e
- the exception cause- Returns:
- the new SAX exception
-
createSAXException
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Parameters:
message
- the custom SAX exception message- Returns:
- the new SAX exception
-
npeSafeCast
Helps casting the input object to given type, avoiding NPEs.- Type Parameters:
T
- the type the input object has to be cast.- Parameters:
obj
- the object has to be cast.- Returns:
- the casted object, if input object is not null, null otherwise.
- Since:
- 3.0
-