org.apache.commons.digester.annotations.providers

Class SetPropertiesRuleProvider

java.lang.Object

org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider

All Implemented Interfaces:

AnnotationRuleProvider<SetProperty,java.lang.reflect.Field,SetPropertiesRule>

public final class SetPropertiesRuleProvider
extends java.lang.Object
implements AnnotationRuleProvider<SetProperty,java.lang.reflect.Field,SetPropertiesRule>

Provides instances of SetPropertiesRule.

Since:

2.1

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.String>	aliases The data structure that stores the aliases.

Constructor Summary

Constructors

Constructor and Description
SetPropertiesRuleProvider()

Method Summary

Modifier and Type	Method and Description
void	addAlias(SetProperty annotation, java.lang.reflect.Field element) Adds a new alias attribute/property name; if the attribute name is not specified, the alias will be considered as property name identity.
SetPropertiesRule	get() Provides an instance of Rule.
void	init(SetProperty annotation, java.lang.reflect.Field element) Initializes the provider.

Methods inherited from class java.lang.Object

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

Field Detail

aliases

private final java.util.Map<java.lang.String,java.lang.String> aliases

The data structure that stores the aliases.

Constructor Detail

SetPropertiesRuleProvider

public SetPropertiesRuleProvider()

Method Detail

init

public void init(SetProperty annotation,
                 java.lang.reflect.Field element)

Initializes the provider.

Specified by:

init in interface AnnotationRuleProvider<SetProperty,java.lang.reflect.Field,SetPropertiesRule>

Parameters:

annotation - the annotation instance.

element - the annotated element reference.

addAlias

public void addAlias(SetProperty annotation,
                     java.lang.reflect.Field element)

Adds a new alias attribute/property name; if the attribute name is not specified, the alias will be considered as property name identity.

Parameters:

annotation - the SetProperty reference.

element - the annotated element reference.

get

public SetPropertiesRule get()

Provides an instance of Rule. Must never return null.

Specified by:

get in interface AnnotationRuleProvider<SetProperty,java.lang.reflect.Field,SetPropertiesRule>

Returns:

an instance of Rule.