Class FromAnnotationsRuleModule

java.lang.Object

org.apache.commons.digester3.binder.AbstractRulesModule

org.apache.commons.digester3.annotations.FromAnnotationsRuleModule

All Implemented Interfaces:

RulesModule

public abstract class FromAnnotationsRuleModule
extends AbstractRulesModule

RulesModule implementation that allows loading rules from annotated classes.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
FromAnnotationsRuleModule()

Method Summary

Modifier and Type	Method	Description
protected final void	bindRulesFrom(Class<?> type)	Scan the input Class, looking for Digester rules expressed via annotations, and binds them.
protected final void	configure()	Configures a RulesBinder via the exposed methods.
protected abstract void	configureRules()	Configures a RulesBinder via the exposed methods.
protected final void	useAnnotationHandlerFactory(AnnotationHandlerFactory annotationHandlerFactory)	Allows users plug a different AnnotationHandlerFactory to create AnnotationHandler instances.
protected final void	useDefaultAnnotationHandlerFactory()	Allows users to switch back to the default AnnotationHandlerFactory implementation.

Methods inherited from class AbstractRulesModule

addError, addError, configure, forPattern, install, rulesBinder

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FromAnnotationsRuleModule

public FromAnnotationsRuleModule()

Method Details

configure

protected final void configure()

Configures a RulesBinder via the exposed methods.

Specified by:

configure in class AbstractRulesModule

configureRules

protected abstract void configureRules()

Configures a RulesBinder via the exposed methods.

useAnnotationHandlerFactory

protected final void useAnnotationHandlerFactory(AnnotationHandlerFactory annotationHandlerFactory)

Allows users plug a different AnnotationHandlerFactory to create AnnotationHandler instances.

Parameters:

annotationHandlerFactory - A custom AnnotationHandlerFactory to create AnnotationHandler instances

useDefaultAnnotationHandlerFactory

protected final void useDefaultAnnotationHandlerFactory()

Allows users to switch back to the default AnnotationHandlerFactory implementation.

bindRulesFrom

protected final void bindRulesFrom(Class<?> type)

Scan the input Class, looking for Digester rules expressed via annotations, and binds them.

Parameters:

type - the type has to be analyzed

See Also:

• DigesterRule