org.apache.commons.digester.annotations
Class DigesterLoader

java.lang.Object
  org.apache.commons.digester.annotations.DigesterLoader

public final class DigesterLoader
extends Object

This class manages the creation of Digester instances analyzing target classes annotated with digester annotations.

Since:

2.1

Constructor Summary

protected

DigesterLoader(AnnotationRuleProviderFactory annotationRuleProviderFactory, DigesterLoaderHandlerFactory digesterLoaderHandlerFactory) Creates a new DigesterLoader instance.

Method Summary

void	addRules(Class<?> target, Digester digester) Add rules to an already created Digester instance, analyzing the digester annotations in the target class.
void	addRulesTo(Class<?> target, FromAnnotationsRuleSet ruleSet) Analyzes the target class and adds the AnnotationRuleProviders to the existing FromAnnotationsRuleSet.
Digester	createDigester(Class<?> target) Creates a new digester which rules are defined by analyzing the digester annotations in the target class.
protected AnnotationRuleProviderFactory	getAnnotationRuleProviderFactory()
protected DigesterLoaderHandlerFactory	getDigesterLoaderHandlerFactory()
RuleSet	getRuleSet(Class<?> target) Builds a new RuleSet analyzing the digester annotations in the target class.

Methods inherited from class java.lang.Object

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

Constructor Detail

DigesterLoader

protected DigesterLoader(AnnotationRuleProviderFactory annotationRuleProviderFactory,
                         DigesterLoaderHandlerFactory digesterLoaderHandlerFactory)

Creates a new DigesterLoader instance.

Parameters:

annotationRuleProviderFactory -

digesterLoaderHandlerFactory -

Method Detail

getAnnotationRuleProviderFactory

protected AnnotationRuleProviderFactory getAnnotationRuleProviderFactory()

getDigesterLoaderHandlerFactory

protected DigesterLoaderHandlerFactory getDigesterLoaderHandlerFactory()

createDigester

public Digester createDigester(Class<?> target)

Creates a new digester which rules are defined by analyzing the digester annotations in the target class.

Parameters:

target - the class has to be analyzed.

Returns:

a new Digester instance.

addRules

public void addRules(Class<?> target,
                     Digester digester)

Add rules to an already created Digester instance, analyzing the digester annotations in the target class.

Parameters:

target - the class has to be analyzed.

digester - the Digester instance reference.

getRuleSet

public RuleSet getRuleSet(Class<?> target)

Builds a new RuleSet analyzing the digester annotations in the target class. It avoids iterate the annotations analysis for already analyzed classes, using an in-memory LRU cache.

Parameters:

target - the class has to be analyzed.

Returns:

a new RuleSet.

addRulesTo

public void addRulesTo(Class<?> target,
                       FromAnnotationsRuleSet ruleSet)

Analyzes the target class and adds the AnnotationRuleProviders to the existing FromAnnotationsRuleSet.

Parameters:

target - the class has to be analyzed.

ruleSet - the RuleSet where adding the providers.