org.apache.tomcat.util.digester

Class SetPropertiesRule

public class SetPropertiesRule extends Rule

Rule implementation that sets properties on the object at the top of the stack, based on attributes with corresponding names.

This rule supports custom mapping of attribute names to property names. The default mapping for particular attributes can be overridden by using (String[] attributeNames, String[] propertyNames). This allows attributes to be mapped to properties with different names. Certain attributes can also be marked to be ignored.

Constructor Summary
SetPropertiesRule(Digester digester)
Default constructor sets only the the associated Digester.
SetPropertiesRule()
Base constructor.
SetPropertiesRule(String attributeName, String propertyName)

Convenience constructor overrides the mapping for just one property.

For details about how this works, see (String[] attributeNames, String[] propertyNames).

SetPropertiesRule(String[] attributeNames, String[] propertyNames)

Constructor allows attribute->property mapping to be overriden.

Two arrays are passed in.

Method Summary
voidaddAlias(String attributeName, String propertyName)

Add an additional attribute name to property name mapping.

voidbegin(Attributes attributes)
Process the beginning of this element.
StringtoString()
Render a printable version of this Rule.

Constructor Detail

SetPropertiesRule

public SetPropertiesRule(Digester digester)

Deprecated: The digester instance is now set in the Digester method. Use SetPropertiesRule instead.

Default constructor sets only the the associated Digester.

Parameters: digester The digester with which this rule is associated

SetPropertiesRule

public SetPropertiesRule()
Base constructor.

SetPropertiesRule

public SetPropertiesRule(String attributeName, String propertyName)

Convenience constructor overrides the mapping for just one property.

For details about how this works, see (String[] attributeNames, String[] propertyNames).

Parameters: attributeName map this attribute propertyName to a property with this name

SetPropertiesRule

public SetPropertiesRule(String[] attributeNames, String[] propertyNames)

Constructor allows attribute->property mapping to be overriden.

Two arrays are passed in. One contains the attribute names and the other the property names. The attribute name / property name pairs are match by position In order words, the first string in the attribute name list matches to the first string in the property name list and so on.

If a property name is null or the attribute name has no matching property name, then this indicates that the attibute should be ignored.

Example One

The following constructs a rule that maps the alt-city attribute to the city property and the alt-state to the state property. All other attributes are mapped as usual using exact name matching.

      SetPropertiesRule(
                new String[] {"alt-city", "alt-state"}, 
                new String[] {"city", "state"});
 
Example Two

The following constructs a rule that maps the class attribute to the className property. The attribute ignore-me is not mapped. All other attributes are mapped as usual using exact name matching.

      SetPropertiesRule(
                new String[] {"class", "ignore-me"}, 
                new String[] {"className"});
 

Parameters: attributeNames names of attributes to map propertyNames names of properties mapped to

Method Detail

addAlias

public void addAlias(String attributeName, String propertyName)

Add an additional attribute name to property name mapping. This is intended to be used from the xml rules.

begin

public void begin(Attributes attributes)
Process the beginning of this element.

Parameters: attributes The attribute list of this element

toString

public String toString()
Render a printable version of this Rule.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.