Class WithMemoryRulesBinder
java.lang.Object
org.apache.commons.digester3.xmlrules.WithMemoryRulesBinder
- All Implemented Interfaces:
RulesBinder
-
Field Summary
FieldsModifier and TypeFieldDescriptionUsed to detect circular includesprivate final PatternStack
A stack used to maintain the current pattern.private final RulesBinder
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Records an error message which will be presented to the user at a later time.void
Records an exception, the full details of which will be logged, and the message of which will be presented to the user at a later time.forPattern
(String pattern) Allows to associate the given pattern to one or more Digester rules.Returns the contextClassLoader
.void
install
(RulesModule rulesModule) Allows sub-modules inclusion while binding rules.
-
Field Details
-
patternStack
A stack used to maintain the current pattern. The Rules XML document type allows nesting of patterns. If an element defines a matching pattern, the resulting pattern is a concatenation of that pattern with all the ancestor elements' patterns. Hence the need for a stack. -
includedFiles
Used to detect circular includes -
wrappedRulesBinder
-
-
Constructor Details
-
WithMemoryRulesBinder
-
-
Method Details
-
getContextClassLoader
Returns the contextClassLoader
.- Specified by:
getContextClassLoader
in interfaceRulesBinder
- Returns:
- The context
ClassLoader
-
addError
Records an error message which will be presented to the user at a later time. Unlike throwing an exception, this enable us to continue configuring the Digester and discover more errors. UsesString.format(String, Object[])
to insert the arguments into the message.- Specified by:
addError
in interfaceRulesBinder
- Parameters:
messagePattern
- The message string patternarguments
- Arguments referenced by the format specifiers in the format string
-
addError
Records an exception, the full details of which will be logged, and the message of which will be presented to the user at a later time. If your Module calls something that you worry may fail, you should catch the exception and pass it into this.- Specified by:
addError
in interfaceRulesBinder
- Parameters:
t
- The exception has to be recorded.
-
install
Allows sub-modules inclusion while binding rules.- Specified by:
install
in interfaceRulesBinder
- Parameters:
rulesModule
- the sub-module has to be included.
-
forPattern
Allows to associate the given pattern to one or more Digester rules.- Specified by:
forPattern
in interfaceRulesBinder
- Parameters:
pattern
- The pattern that this rule should match- Returns:
- The Digester rules builder
-
getPatternStack
- Returns:
- the pattern stack
-
getIncludedFiles
- Returns:
- the set of included files
-