Class DefaultRulesBinder
- java.lang.Object
-
- org.apache.commons.digester3.binder.DefaultRulesBinder
-
- All Implemented Interfaces:
RulesBinder
final class DefaultRulesBinder extends java.lang.Object implements RulesBinder
The default Digester EDSL implementation.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.ClassLoader
classLoader
private java.util.List<ErrorMessage>
errors
Errors that can occur during binding time or rules creation.private FromBinderRuleSet
fromBinderRuleSet
-
Constructor Summary
Constructors Constructor Description DefaultRulesBinder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addError(java.lang.String messagePattern, java.lang.Object... arguments)
Records an error message which will be presented to the user at a later time.void
addError(java.lang.Throwable t)
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.private void
addError(ErrorMessage errorMessage)
Records an error, the full details of which will be logged, and the message of which will be presented to the user at a later time.(package private) int
errorsSize()
LinkedRuleBuilder
forPattern(java.lang.String pattern)
Allows to associate the given pattern to one or more Digester rules.java.lang.ClassLoader
getContextClassLoader()
Returns the contextClassLoader
.(package private) java.lang.Iterable<ErrorMessage>
getErrors()
(package private) RuleSet
getFromBinderRuleSet()
(package private) boolean
hasError()
(package private) void
initialize(java.lang.ClassLoader classLoader)
void
install(RulesModule rulesModule)
Allows sub-modules inclusion while binding rules.
-
-
-
Field Detail
-
errors
private final java.util.List<ErrorMessage> errors
Errors that can occur during binding time or rules creation.
-
fromBinderRuleSet
private final FromBinderRuleSet fromBinderRuleSet
-
classLoader
private java.lang.ClassLoader classLoader
-
-
Method Detail
-
initialize
void initialize(java.lang.ClassLoader classLoader)
- Parameters:
classLoader
-
-
getContextClassLoader
public java.lang.ClassLoader getContextClassLoader()
Returns the contextClassLoader
.- Specified by:
getContextClassLoader
in interfaceRulesBinder
- Returns:
- The context
ClassLoader
-
addError
public void addError(java.lang.String messagePattern, java.lang.Object... arguments)
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
public void addError(java.lang.Throwable t)
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.
-
addError
private void addError(ErrorMessage errorMessage)
Records an error, the full details of which will be logged, and the message of which will be presented to the user at a later time.- Parameters:
errorMessage
- The error to record.
-
install
public void install(RulesModule rulesModule)
Allows sub-modules inclusion while binding rules.- Specified by:
install
in interfaceRulesBinder
- Parameters:
rulesModule
- the sub-module has to be included.
-
forPattern
public LinkedRuleBuilder forPattern(java.lang.String pattern)
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
-
hasError
boolean hasError()
- Returns:
-
errorsSize
int errorsSize()
- Returns:
-
getErrors
java.lang.Iterable<ErrorMessage> getErrors()
- Returns:
-
getFromBinderRuleSet
RuleSet getFromBinderRuleSet()
- Returns:
-
-