Class Digester
- java.lang.Object
-
- org.xml.sax.helpers.DefaultHandler
-
- org.apache.tomcat.util.digester.Digester
-
- All Implemented Interfaces:
ContentHandler
,DTDHandler
,EntityResolver
,ErrorHandler
public class Digester extends DefaultHandler
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. This package was inspired by the
XmlMapper
class that was part of Tomcat 3.0 and 3.1, but is organized somewhat differently.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.IMPLEMENTATION NOTE - 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 working with XML schema
-
-
Field Summary
Fields Modifier and Type Field Description protected StringBuilder
bodyText
The body text of the current element.protected ArrayStack<StringBuilder>
bodyTexts
The stack of body text string buffers for surrounding elements.protected ClassLoader
classLoader
The class loader to use for instantiating application objects.protected boolean
configured
Has this Digester been configured yet.protected EntityResolver
entityResolver
The EntityResolver used by the SAX parser.protected HashMap<String,String>
entityValidator
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.protected ErrorHandler
errorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.protected SAXParserFactory
factory
The SAXParserFactory that is created the first time we need it.protected Map<Class<?>,List<String>>
fakeAttributes
Fake attributes map (attributes are often used for object creation).protected String
JAXP_SCHEMA_LANGUAGE
Deprecated.This is now managed byParserFeatureSetterFactory
protected Locator
locator
The Locator associated with our parser.protected Logger
log
The Log to which most logging calls will be made.protected String
match
The current match pattern for nested element processing.protected ArrayStack<List<Rule>>
matches
Stack whose elements are List objects, each containing a list of Rule objects as returned from Rules.getMatch().protected boolean
namespaceAware
Do we want a "namespace aware" parser.protected HashMap<String,ArrayStack<String>>
namespaces
Registered namespaces we are currently processing.protected ArrayStack<Object>
params
The parameters stack being utilized by CallMethodRule and CallParamRule rules.protected SAXParser
parser
The SAXParser we will use to parse the input stream.protected String
publicId
The public identifier of the DTD we are currently parsing under (if any).protected ResourceBundle
rb
protected XMLReader
reader
The XMLReader used to parse digester rules.protected Object
root
The "root" element of the stack (in other words, the last object that was popped.protected Rules
rules
TheRules
implementation containing our collection ofRule
instances and associated matching policy.protected boolean
rulesValidation
Warn on missing attributes and elements.protected Logger
saxLog
The Log to which all SAX event related logging calls will be made.protected String
schemaLanguage
The XML schema language to use for validating an XML instance.protected String
schemaLocation
The XML schema to use for validating an XML instance.protected ArrayStack<Object>
stack
The object stack being constructed.protected boolean
useContextClassLoader
Do we want to use the Context ClassLoader when loading classes for instantiating new objects.protected boolean
validating
Do we want to use a validating parser.protected static String
W3C_XML_SCHEMA
The schema language supported.
-
Constructor Summary
Constructors Constructor Description Digester()
Construct a new Digester with default properties.Digester(SAXParser parser)
Construct a new Digester, allowing a SAXParser to be passed in.Digester(XMLReader reader)
Construct a new Digester, allowing an XMLReader to be passed in.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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<?> clazz)
Add a "factory create" rule for the specified parameters.void
addFactoryCreate(String pattern, Class<?> clazz, boolean ignoreCreateExceptions)
Add a "factory create" rule for the specified parameters.void
addFactoryCreate(String pattern, Class<?> clazz, String attributeName)
Add a "factory create" rule for the specified parameters.void
addFactoryCreate(String pattern, Class 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
addRule(String pattern, Rule rule)
Register a new Rule matching the specified pattern.void
addRuleSet(RuleSet ruleSet)
Register a set of Rule instances defined in a RuleSet.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
addSetTop(String pattern, String methodName)
Add a "set top" rule for the specified parameters.void
addSetTop(String pattern, String methodName, String paramType)
Add a "set top" rule for the specified parameters.void
characters(char[] buffer, int start, int length)
Process notification of character data received from the body of an XML element.void
clear()
Clear the current contents of the object stack.protected void
configure()
Provide a hook for lazy configuration of thisDigester
instance.SAXException
createSAXException(Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occursSAXException
createSAXException(String message)
Create a SAX exception which also understands about the location in the digester file where the exception occursSAXException
createSAXException(String message, Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occursvoid
endDocument()
Process notification of the end of the document being reached.void
endElement(String namespaceURI, String localName, String qName)
Process notification of the end of an XML element being reached.void
endPrefixMapping(String prefix)
Process notification that a namespace prefix is going out of scope.void
error(SAXParseException exception)
Forward notification of a parsing error to the application supplied error handler (if any).void
fatalError(SAXParseException exception)
Forward notification of a fatal parsing error to the application supplied error handler (if any).String
findNamespaceURI(String prefix)
Return the currently mapped namespace URI for the specified prefix, if any; otherwise returnnull
.ClassLoader
getClassLoader()
Return the class loader to be used for instantiating application objects when required.int
getCount()
Return the current depth of the element stack.String
getCurrentElementName()
Return the name of the XML element that is currently being processed.int
getDebug()
Deprecated.This method now always returns 0.Locator
getDocumentLocator()
Gets the document locator associated with our parser.EntityResolver
getEntityResolver()
Return the Entity Resolver used by the SAX parser.ErrorHandler
getErrorHandler()
Return the error handler for this Digester.SAXParserFactory
getFactory()
Return the SAXParserFactory we will use, creating one if necessary.Map<Class<?>,List<String>>
getFakeAttributes()
Return the fake attributes list.boolean
getFeature(String feature)
Returns a flag indicating whether the requested feature is supported by the underlying implementation oforg.xml.sax.XMLReader
.Logger
getLogger()
Return the current Logger associated with this instance of the DigesterString
getMatch()
Return the current rule match pathboolean
getNamespaceAware()
Return the "namespace aware" flag for parsers we create.SAXParser
getParser()
Return the SAXParser we will use to parse the input stream.Object
getProperty(String property)
Return the current value of the specified property for the underlyingXMLReader
implementation.String
getPublicId()
Return the public identifier of the DTD we are currently parsing under, if any.XMLReader
getReader()
Deprecated.Use getXMLReader() instead, which can throw a SAXException if the reader cannot be instantiatedObject
getRoot()
When the Digester is being used as a SAXContentHandler, this method allows you to access the root object that has been created after parsing.String
getRuleNamespaceURI()
Return the namespace URI that will be applied to all subsequently addedRule
objects.Rules
getRules()
Return theRules
implementation object containing our rules collection and associated matching policy.boolean
getRulesValidation()
Return the rules validation flag.Logger
getSAXLogger()
Gets the logger used for logging SAX-related information.String
getSchema()
Return the XML Schema URI used for validating an XML instance.String
getSchemaLanguage()
Return the XML Schema language used when parsing.boolean
getUseContextClassLoader()
Return the boolean as to whether the context classloader should be used.boolean
getValidating()
Return the validating parser flag.XMLReader
getXMLReader()
Return the XMLReader to be used for parsing the input document.void
ignorableWhitespace(char[] buffer, int start, int len)
Process notification of ignorable whitespace received from the body of an XML element.protected void
initialize()
Provides a hook for lazy initialization of thisDigester
instance.boolean
isEmpty(String stackName)
Is the stack with the given name empty?boolean
isFakeAttribute(Object object, String name)
Determine if an attribute is a fake attribute.void
log(String message)
Deprecated.Call getLogger() and use it's logging methodsvoid
log(String message, Throwable exception)
Deprecated.Call getLogger() and use it's logging methodsvoid
notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration event.Object
parse(File file)
Parse the content of the specified file using this Digester.Object
parse(InputStream input)
Parse the content of the specified input stream using this Digester.Object
parse(Reader reader)
Parse the content of the specified reader using this Digester.Object
parse(String uri)
Parse the content of the specified URI using this Digester.Object
parse(InputSource input)
Parse the content of the specified input source using this Digester.Object
peek()
Return the top object on the stack without removing it.Object
peek(int n)
Return the n'th object down the stack, where 0 is the top element and [getCount()-1] is the bottom element.Object
peek(String stackName)
Gets the top object from the stack with the given name.Object
peekParams()
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.Object
pop()
Pop the top object off of the stack, and return it.Object
pop(String stackName)
Pops (gets and removes) the top object from the stack with the given name.Object
popParams()
Pop the top object off of the parameters stack, and return it.void
processingInstruction(String target, String data)
Process notification of a processing instruction that was encountered.void
push(Object object)
Push a new object onto the top of the object stack.void
push(String stackName, Object value)
Pushes the given object onto the stack with the given name.void
pushParams(Object object)
Push a new object onto the top of the parameters stack.void
register(String publicId, String entityURL)
Register the specified DTD URL for the specified public identifier.void
reset()
InputSource
resolveEntity(String publicId, String systemId)
Resolve the requested external entity.void
setClassLoader(ClassLoader classLoader)
Set the class loader to be used for instantiating application objects when required.void
setDebug(int debug)
Deprecated.This method now has no effect at all.void
setDocumentLocator(Locator locator)
Sets the document locator associated with our parser.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
setFakeAttributes(Map<Class<?>,List<String>> fakeAttributes)
Set the fake attributes.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(Logger 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 publid 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
setRules(Rules rules)
Set theRules
implementation object containing our rules collection and associated matching policy.void
setRulesValidation(boolean rulesValidation)
Set the rules validation flag.void
setSAXLogger(Logger saxLog)
Sets the logger used for logging SAX-related information.void
setSchema(String schemaLocation)
Set the XML Schema URI used for validating a XML Instance.void
setSchemaLanguage(String schemaLanguage)
Set the XML Schema language used when parsing.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
skippedEntity(String name)
Process notification of a skipped entity.void
startDocument()
Process notification of the beginning of the document being reached.void
startElement(String namespaceURI, String localName, String qName, Attributes list)
Process notification of the start of an XML element being reached.void
startPrefixMapping(String prefix, String namespaceURI)
Process notification that a namespace prefix is coming in to scope.void
unparsedEntityDecl(String name, String publicId, String systemId, String notation)
Receive notification of an unparsed entity declaration event.void
warning(SAXParseException exception)
Forward notification of a parse warning to the application supplied error handler (if any).
-
-
-
Field Detail
-
bodyText
protected StringBuilder bodyText
The body text of the current element.
-
bodyTexts
protected ArrayStack<StringBuilder> bodyTexts
The stack of body text string buffers for surrounding elements.
-
matches
protected ArrayStack<List<Rule>> 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
protected ClassLoader 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
protected boolean configured
Has this Digester been configured yet.
-
entityResolver
protected EntityResolver entityResolver
The EntityResolver used by the SAX parser. By default it use this class
-
entityValidator
protected HashMap<String,String> entityValidator
The URLs of entityValidator that have been registered, keyed by the public identifier that corresponds.
-
errorHandler
protected ErrorHandler errorHandler
The application-supplied error handler that is notified when parsing warnings, errors, or fatal errors occur.
-
factory
protected SAXParserFactory factory
The SAXParserFactory that is created the first time we need it.
-
JAXP_SCHEMA_LANGUAGE
protected String JAXP_SCHEMA_LANGUAGE
Deprecated.This is now managed byParserFeatureSetterFactory
-
locator
protected Locator locator
The Locator associated with our parser.
-
match
protected String match
The current match pattern for nested element processing.
-
namespaceAware
protected boolean namespaceAware
Do we want a "namespace aware" parser.
-
namespaces
protected HashMap<String,ArrayStack<String>> namespaces
Registered namespaces we are currently processing. The key is the namespace prefix that was declared in the document. The value is an ArrayStack 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).
-
params
protected ArrayStack<Object> params
The parameters stack being utilized by CallMethodRule and CallParamRule rules.
-
parser
protected SAXParser parser
The SAXParser we will use to parse the input stream.
-
publicId
protected String publicId
The public identifier of the DTD we are currently parsing under (if any).
-
reader
protected XMLReader reader
The XMLReader used to parse digester rules.
-
root
protected Object root
The "root" element of the stack (in other words, the last object that was popped.
-
rules
protected Rules 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.
-
schemaLanguage
protected String schemaLanguage
The XML schema language to use for validating an XML instance. By default this value is set toW3C_XML_SCHEMA
-
schemaLocation
protected String schemaLocation
The XML schema to use for validating an XML instance.
-
stack
protected ArrayStack<Object> stack
The object stack being constructed.
-
useContextClassLoader
protected boolean useContextClassLoader
Do we want to use the Context ClassLoader when loading classes for instantiating new objects. Default isfalse
.
-
validating
protected boolean validating
Do we want to use a validating parser.
-
rulesValidation
protected boolean rulesValidation
Warn on missing attributes and elements.
-
fakeAttributes
protected Map<Class<?>,List<String>> fakeAttributes
Fake attributes map (attributes are often used for object creation).
-
log
protected Logger log
The Log to which most logging calls will be made.
-
rb
protected final ResourceBundle rb
-
saxLog
protected Logger saxLog
The Log to which all SAX event related logging calls will be made.
-
W3C_XML_SCHEMA
protected static final String W3C_XML_SCHEMA
The schema language supported. By default, we use this one.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Digester
public Digester()
Construct a new Digester with default properties.
-
Digester
public Digester(SAXParser parser)
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). Thanks for the request to change go to James House ([email protected]). This may help in places where you are able to load JAXP 1.1 classes yourself.
-
Digester
public Digester(XMLReader reader)
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.
-
-
Method Detail
-
findNamespaceURI
public String findNamespaceURI(String prefix)
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
-
getClassLoader
public ClassLoader 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.
- The class loader set by
-
setClassLoader
public void setClassLoader(ClassLoader classLoader)
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.
-
getCurrentElementName
public String getCurrentElementName()
Return the name of the XML element that is currently being processed.
-
getDebug
public int getDebug()
Deprecated.This method now always returns 0. Digester uses the apache jakarta commons-logging library; see the documentation for that library for more information.Return the debugging detail level of our currently enabled logger.
-
setDebug
public void setDebug(int debug)
Deprecated.This method now has no effect at all. Digester uses the apache jakarta comons-logging library; see the documentation for that library for more information.Set the debugging detail level of our currently enabled logger.- Parameters:
debug
- New debugging detail level (0=off, increasing integers for more detail)
-
getErrorHandler
public ErrorHandler getErrorHandler()
Return the error handler for this Digester.
-
setErrorHandler
public void setErrorHandler(ErrorHandler errorHandler)
Set the error handler for this Digester.- Parameters:
errorHandler
- The new error handler
-
getFactory
public SAXParserFactory getFactory()
Return 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 for information about the standard SAX2 feature flags.- Parameters:
feature
- Name of the feature to inquire about- 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 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 Logger getLogger()
Return the current Logger associated with this instance of the Digester
-
setLogger
public void setLogger(Logger log)
Set the current logger for this Digester.
-
getSAXLogger
public Logger getSAXLogger()
Gets the logger used for logging SAX-related information. Note the output is finely grained.- Since:
- 1.6
-
setSAXLogger
public void setSAXLogger(Logger saxLog)
Sets the logger used for logging SAX-related information. Note the output is finely grained.- Parameters:
saxLog
- Log, not null- Since:
- 1.6
-
getMatch
public String getMatch()
Return the current rule match path
-
getNamespaceAware
public boolean getNamespaceAware()
Return 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
-
setPublicId
public void setPublicId(String publicId)
Set the publid id of the current file being parse.- Parameters:
publicId
- the DTD/Schema public's id.
-
getPublicId
public String getPublicId()
Return the public identifier of the DTD we are currently parsing under, if any.
-
getRuleNamespaceURI
public String getRuleNamespaceURI()
Return the namespace URI that will be applied to all subsequently addedRule
objects.
-
setRuleNamespaceURI
public void setRuleNamespaceURI(String ruleNamespaceURI)
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
public SAXParser getParser()
Return the SAXParser we will use to parse the input stream. If there is a problem creating the parser, returnnull
.
-
getProperty
public Object getProperty(String property) throws SAXNotRecognizedException, SAXNotSupportedException
Return the current value of the specified property for the underlyingXMLReader
implementation. See for information about the standard SAX2 properties.- Parameters:
property
- Property name to be retrieved- 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 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
-
getReader
public XMLReader getReader()
Deprecated.Use getXMLReader() instead, which can throw a SAXException if the reader cannot be instantiatedBy setting the reader in the constructor, you can bypass JAXP and be able to use digester in Weblogic 6.0.
-
getRules
public Rules 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.
-
setRules
public void setRules(Rules rules)
Set theRules
implementation object containing our rules collection and associated matching policy.- Parameters:
rules
- New Rules implementation
-
getSchema
public String getSchema()
Return the XML Schema URI used for validating an XML instance.
-
setSchema
public void setSchema(String schemaLocation)
Set the XML Schema URI used for validating a XML Instance.- Parameters:
schemaLocation
- a URI to the schema.
-
getSchemaLanguage
public String getSchemaLanguage()
Return the XML Schema language used when parsing.
-
setSchemaLanguage
public void setSchemaLanguage(String schemaLanguage)
Set the XML Schema language used when parsing. By default, we use W3C.- Parameters:
schemaLanguage
- a URI to the schema language.
-
getUseContextClassLoader
public boolean getUseContextClassLoader()
Return the boolean as to whether the context classloader should be used.
-
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.
-
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.
-
getRulesValidation
public boolean getRulesValidation()
Return the rules validation flag.
-
setRulesValidation
public void setRulesValidation(boolean rulesValidation)
Set the rules validation flag. This must be called beforeparse()
is called the first time.- Parameters:
rulesValidation
- The new rules validation flag.
-
getFakeAttributes
public Map<Class<?>,List<String>> getFakeAttributes()
Return the fake attributes list.
-
isFakeAttribute
public boolean isFakeAttribute(Object object, String name)
Determine if an attribute is a fake attribute.
-
setFakeAttributes
public void setFakeAttributes(Map<Class<?>,List<String>> fakeAttributes)
Set the fake attributes.- Parameters:
fakeAttributes
- The new fake attributes.
-
getXMLReader
public XMLReader getXMLReader() throws SAXException
Return the XMLReader to be used for parsing the input document. FIX ME: there is a bug in JAXP/XERCES that prevent the use of a parser that contains a schema with a DTD.- Throws:
SAXException
- if no XMLReader can be instantiated
-
characters
public void characters(char[] buffer, int start, int length) throws SAXException
Process notification of character data received from the body of an XML element.- Specified by:
characters
in interfaceContentHandler
- Overrides:
characters
in classDefaultHandler
- Parameters:
buffer
- The characters from the XML documentstart
- Starting offset into the bufferlength
- Number of characters from the buffer- Throws:
SAXException
- if a parsing error is to be reported
-
endDocument
public void endDocument() throws SAXException
Process notification of the end of the document being reached.- Specified by:
endDocument
in interfaceContentHandler
- Overrides:
endDocument
in classDefaultHandler
- Throws:
SAXException
- if a parsing error is to be reported
-
endElement
public void endElement(String namespaceURI, String localName, String qName) throws SAXException
Process notification of the end of an XML element being reached.- Specified by:
endElement
in interfaceContentHandler
- Overrides:
endElement
in classDefaultHandler
- Parameters:
namespaceURI
- - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName
- - The qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.- Throws:
SAXException
- if a parsing error is to be reported
-
endPrefixMapping
public void endPrefixMapping(String prefix) throws SAXException
Process notification that a namespace prefix is going out of scope.- Specified by:
endPrefixMapping
in interfaceContentHandler
- Overrides:
endPrefixMapping
in classDefaultHandler
- Parameters:
prefix
- Prefix that is going out of scope- Throws:
SAXException
- if a parsing error is to be reported
-
ignorableWhitespace
public void ignorableWhitespace(char[] buffer, int start, int len) throws SAXException
Process notification of ignorable whitespace received from the body of an XML element.- Specified by:
ignorableWhitespace
in interfaceContentHandler
- Overrides:
ignorableWhitespace
in classDefaultHandler
- Parameters:
buffer
- The characters from the XML documentstart
- Starting offset into the bufferlen
- Number of characters from the buffer- Throws:
SAXException
- if a parsing error is to be reported
-
processingInstruction
public void processingInstruction(String target, String data) throws SAXException
Process notification of a processing instruction that was encountered.- Specified by:
processingInstruction
in interfaceContentHandler
- Overrides:
processingInstruction
in classDefaultHandler
- Parameters:
target
- The processing instruction targetdata
- The processing instruction data (if any)- Throws:
SAXException
- if a parsing error is to be reported
-
getDocumentLocator
public Locator getDocumentLocator()
Gets the document locator associated with our parser.- Returns:
- the Locator supplied by the document parser
-
setDocumentLocator
public void setDocumentLocator(Locator locator)
Sets the document locator associated with our parser.- Specified by:
setDocumentLocator
in interfaceContentHandler
- Overrides:
setDocumentLocator
in classDefaultHandler
- Parameters:
locator
- The new locator
-
skippedEntity
public void skippedEntity(String name) throws SAXException
Process notification of a skipped entity.- Specified by:
skippedEntity
in interfaceContentHandler
- Overrides:
skippedEntity
in classDefaultHandler
- Parameters:
name
- Name of the skipped entity- Throws:
SAXException
- if a parsing error is to be reported
-
startDocument
public void startDocument() throws SAXException
Process notification of the beginning of the document being reached.- Specified by:
startDocument
in interfaceContentHandler
- Overrides:
startDocument
in classDefaultHandler
- Throws:
SAXException
- if a parsing error is to be reported
-
startElement
public void startElement(String namespaceURI, String localName, String qName, Attributes list) throws SAXException
Process notification of the start of an XML element being reached.- Specified by:
startElement
in interfaceContentHandler
- Overrides:
startElement
in classDefaultHandler
- Parameters:
namespaceURI
- The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName
- The local name (without prefix), or the empty string if Namespace processing is not being performed.qName
- The qualified name (with prefix), or the empty string if qualified names are not available.\list
- The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.- Throws:
SAXException
- if a parsing error is to be reported
-
startPrefixMapping
public void startPrefixMapping(String prefix, String namespaceURI) throws SAXException
Process notification that a namespace prefix is coming in to scope.- Specified by:
startPrefixMapping
in interfaceContentHandler
- Overrides:
startPrefixMapping
in classDefaultHandler
- Parameters:
prefix
- Prefix that is being declarednamespaceURI
- Corresponding namespace URI being mapped to- Throws:
SAXException
- if a parsing error is to be reported
-
notationDecl
public void notationDecl(String name, String publicId, String systemId)
Receive notification of a notation declaration event.- Specified by:
notationDecl
in interfaceDTDHandler
- Overrides:
notationDecl
in classDefaultHandler
- Parameters:
name
- The notation namepublicId
- The public identifier (if any)systemId
- The system identifier (if any)
-
unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notation)
Receive notification of an unparsed entity declaration event.- Specified by:
unparsedEntityDecl
in interfaceDTDHandler
- Overrides:
unparsedEntityDecl
in classDefaultHandler
- Parameters:
name
- The unparsed entity namepublicId
- The public identifier (if any)systemId
- The system identifier (if any)notation
- The name of the associated notation
-
setEntityResolver
public void setEntityResolver(EntityResolver entityResolver)
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
public EntityResolver getEntityResolver()
Return the Entity Resolver used by the SAX parser.- Returns:
- Return the Entity Resolver used by the SAX parser.
-
resolveEntity
public InputSource resolveEntity(String publicId, String systemId) throws SAXException
Resolve the requested external entity.- Specified by:
resolveEntity
in interfaceEntityResolver
- Overrides:
resolveEntity
in classDefaultHandler
- Parameters:
publicId
- The public identifier of the entity being referencedsystemId
- The system identifier of the entity being referenced- Throws:
SAXException
- if a parsing exception occurs
-
error
public void error(SAXParseException exception) throws SAXException
Forward notification of a parsing error to the application supplied error handler (if any).- Specified by:
error
in interfaceErrorHandler
- Overrides:
error
in classDefaultHandler
- Parameters:
exception
- The error information- Throws:
SAXException
- if a parsing exception occurs
-
fatalError
public void fatalError(SAXParseException exception) throws SAXException
Forward notification of a fatal parsing error to the application supplied error handler (if any).- Specified by:
fatalError
in interfaceErrorHandler
- Overrides:
fatalError
in classDefaultHandler
- Parameters:
exception
- The fatal error information- Throws:
SAXException
- if a parsing exception occurs
-
warning
public void warning(SAXParseException exception) throws SAXException
Forward notification of a parse warning to the application supplied error handler (if any).- Specified by:
warning
in interfaceErrorHandler
- Overrides:
warning
in classDefaultHandler
- Parameters:
exception
- The warning information- Throws:
SAXException
- if a parsing exception occurs
-
log
public void log(String message)
Deprecated.Call getLogger() and use it's logging methodsLog a message to our associated logger.- Parameters:
message
- The message to be logged
-
log
public void log(String message, Throwable exception)
Deprecated.Call getLogger() and use it's logging methodsLog a message and exception to our associated logger.- Parameters:
message
- The message to be logged
-
parse
public Object parse(File file) throws IOException, SAXException
Parse the content of the specified file using this Digester. Returns the root element from the object stack (if any).- Parameters:
file
- File containing the XML data to be parsed- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
parse
public Object parse(InputSource input) throws IOException, SAXException
Parse the content of the specified input source using this Digester. Returns the root element from the object stack (if any).- Parameters:
input
- Input source containing the XML data to be parsed- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
parse
public Object parse(InputStream input) throws IOException, SAXException
Parse the content of the specified input stream using this Digester. Returns the root element from the object stack (if any).- Parameters:
input
- Input stream containing the XML data to be parsed- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
parse
public Object parse(Reader reader) throws IOException, SAXException
Parse the content of the specified reader using this Digester. Returns the root element from the object stack (if any).- Parameters:
reader
- Reader containing the XML data to be parsed- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
parse
public Object parse(String uri) throws IOException, SAXException
Parse the content of the specified URI using this Digester. Returns the root element from the object stack (if any).- Parameters:
uri
- URI containing the XML data to be parsed- Throws:
IOException
- if an input/output error occursSAXException
- if a parsing exception occurs
-
register
public void register(String publicId, String entityURL)
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
-
addRule
public void addRule(String pattern, Rule rule)
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
public void addRuleSet(RuleSet ruleSet)
Register a set of Rule instances defined in a RuleSet.- Parameters:
ruleSet
- The RuleSet instance to configure from
-
addCallMethod
public void addCallMethod(String pattern, String methodName)
Add an "call method" rule for a method which accepts no arguments.- Parameters:
pattern
- Element matching patternmethodName
- Method name to be called- See Also:
CallMethodRule
-
addCallMethod
public void addCallMethod(String pattern, String methodName, int paramCount)
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:
CallMethodRule
-
addCallMethod
public void addCallMethod(String pattern, String methodName, int paramCount, String[] paramTypes)
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:
CallMethodRule
-
addCallMethod
public void addCallMethod(String pattern, String methodName, int paramCount, Class<?>[] paramTypes)
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:
CallMethodRule
-
addCallParam
public void addCallParam(String pattern, int paramIndex)
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:
CallParamRule
-
addCallParam
public void addCallParam(String pattern, int paramIndex, String attributeName)
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:
CallParamRule
-
addCallParam
public void addCallParam(String pattern, int paramIndex, boolean fromStack)
Add a "call parameter" rule. This will either take a parameter from the stack or from the current element body text.- Parameters:
paramIndex
- The zero-relative parameter numberfromStack
- Should the call parameter be taken from the top of the stack?- See Also:
CallParamRule
-
addCallParam
public void addCallParam(String pattern, int paramIndex, int stackIndex)
Add a "call parameter" rule that sets a parameter from the stack. This takes a parameter from the given position on the stack.- Parameters:
paramIndex
- 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:
CallMethodRule
-
addCallParamPath
public void addCallParamPath(String pattern, int paramIndex)
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:
CallMethodRule
-
addObjectParam
public void addObjectParam(String pattern, int paramIndex, Object paramObj)
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:
paramIndex
- The zero-relative parameter numberparamObj
- Any arbitrary object to be passed to the target method.- Since:
- 1.6
- See Also:
CallMethodRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, String className)
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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<?> clazz)
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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, String className, 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 patternclassName
- Java class name of the object creation factory classattributeName
- Attribute name which, if present, overrides the value specified byclassName
- See Also:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<?> 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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, ObjectCreationFactory creationFactory)
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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, String className, boolean ignoreCreateExceptions)
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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class<?> 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:
FactoryCreateRule
-
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:
FactoryCreateRule
-
addFactoryCreate
public void addFactoryCreate(String pattern, Class 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:
FactoryCreateRule
-
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:
FactoryCreateRule
-
addObjectCreate
public void addObjectCreate(String pattern, String className)
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclassName
- Java class name to be created- See Also:
ObjectCreateRule
-
addObjectCreate
public void addObjectCreate(String pattern, Class<?> clazz)
Add an "object create" rule for the specified parameters.- Parameters:
pattern
- Element matching patternclazz
- Java class to be created- See Also:
ObjectCreateRule
-
addObjectCreate
public void addObjectCreate(String pattern, String className, String attributeName)
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:
ObjectCreateRule
-
addObjectCreate
public void addObjectCreate(String pattern, String attributeName, Class<?> clazz)
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:
ObjectCreateRule
-
addSetNext
public void addSetNext(String pattern, String methodName)
Add a "set next" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element- See Also:
SetNextRule
-
addSetNext
public void addSetNext(String pattern, String methodName, String paramType)
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:
SetNextRule
-
addSetRoot
public void addSetRoot(String pattern, String methodName)
AddSetRootRule
with the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the root object- See Also:
SetRootRule
-
addSetRoot
public void addSetRoot(String pattern, String methodName, String paramType)
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:
SetRootRule
-
addSetProperties
public void addSetProperties(String pattern)
Add a "set properties" rule for the specified parameters.- Parameters:
pattern
- Element matching pattern- See Also:
SetPropertiesRule
-
addSetProperties
public void addSetProperties(String pattern, String attributeName, String propertyName)
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:
SetPropertiesRule
-
addSetProperties
public void addSetProperties(String pattern, String[] attributeNames, String[] propertyNames)
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:
SetPropertiesRule
-
addSetProperty
public void addSetProperty(String pattern, String name, String value)
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:
SetPropertyRule
-
addSetTop
public void addSetTop(String pattern, String methodName)
Add a "set top" rule for the specified parameters.- Parameters:
pattern
- Element matching patternmethodName
- Method name to call on the parent element- See Also:
SetTopRule
-
addSetTop
public void addSetTop(String pattern, String methodName, String paramType)
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:
SetTopRule
-
clear
public void clear()
Clear the current contents of the object stack.Calling this method might allow another document of the same type to be correctly parsed. However this method was not intended for this purpose. In general, a separate Digester object should be created for each document to be parsed.
-
reset
public void reset()
-
peek
public Object peek()
Return the top object on the stack without removing it. If there are no objects on the stack, returnnull
.
-
peek
public Object 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
.- Parameters:
n
- Index of the desired element, where 0 is the top of the stack, 1 is the next element down, and so on.
-
pop
public Object pop()
Pop the top object off of the stack, and return it. If there are no objects on the stack, returnnull
.
-
push
public void push(Object object)
Push a new object onto the top of the object stack.- Parameters:
object
- The new object
-
push
public void push(String stackName, Object value)
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.- 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
public Object pop(String stackName)
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.
- 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 - Throws:
EmptyStackException
- if the named stack is empty- Since:
- 1.6
-
peek
public Object peek(String stackName)
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.
- 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 - Throws:
EmptyStackException
- if the named stack is empty- Since:
- 1.6
-
isEmpty
public boolean isEmpty(String stackName)
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 Object getRoot()
When the Digester is being used as a SAXContentHandler, this method allows you to access the root object that has been created after parsing.- Returns:
- the root object that has been created after parsing or null if the digester has not parsed any XML yet.
-
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.
-
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
-
peekParams
public Object 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
.
-
peekParams
public 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. 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.
-
popParams
public Object 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
.
-
pushParams
public void pushParams(Object object)
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
public SAXException createSAXException(String message, Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Returns:
- the new exception
-
createSAXException
public SAXException createSAXException(Exception e)
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Returns:
- the new exception
-
createSAXException
public SAXException createSAXException(String message)
Create a SAX exception which also understands about the location in the digester file where the exception occurs- Returns:
- the new exception
-
-