Constructor Detail

• SetPropertiesRule

  @Deprecated
  public SetPropertiesRule(Digester digester)

  Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) 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 SetPropertiesRule(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 overridden.

  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 attribute 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

• begin

  public void begin(String namespace,
           String theName,
           Attributes attributes)
             throws Exception

  Process the beginning of this element.

  Overrides:

  begin in class Rule

  Parameters:

  namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace

  theName - the local name if the parser is namespace aware, or just the element name otherwise

  attributes - The attribute list for this element

  Throws:

  Exception

• 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.

• toString

  public String toString()

  Render a printable version of this Rule.

  Overrides:

  toString in class Object