Class SetPropertiesRule
- java.lang.Object
-
- org.apache.commons.digester3.Rule
-
- org.apache.commons.digester3.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
SetPropertiesRule(String[] attributeNames, String[] propertyNames)
. This allows attributes to be mapped to properties with different names. Certain attributes can also be marked to be ignored.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.String,java.lang.String>
aliases
private boolean
ignoreMissingProperty
Used to determine whether the parsing should fail if an property specified in the XML is missing from the bean.
-
Constructor Summary
Constructors Constructor Description SetPropertiesRule()
Base constructor.SetPropertiesRule(java.lang.String[] attributeNames, java.lang.String[] propertyNames)
Constructor allows attribute->property mapping to be overriden.SetPropertiesRule(java.lang.String attributeName, java.lang.String propertyName)
Convenience constructor overrides the mapping for just one property.SetPropertiesRule(java.util.Map<java.lang.String,java.lang.String> aliases)
Constructor allows attribute->property mapping to be overriden.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAlias(java.lang.String attributeName, java.lang.String propertyName)
Add an additional attribute name to property name mapping.void
begin(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes)
This method is called when the beginning of a matching XML element is encountered.boolean
isIgnoreMissingProperty()
Are attributes found in the xml without matching properties to be ignored?void
setIgnoreMissingProperty(boolean ignoreMissingProperty)
Sets whether attributes found in the xml without matching properties should be ignored.java.lang.String
toString()
-
Methods inherited from class org.apache.commons.digester3.Rule
body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
-
-
-
Field Detail
-
aliases
private final java.util.Map<java.lang.String,java.lang.String> aliases
-
ignoreMissingProperty
private boolean ignoreMissingProperty
Used to determine whether the parsing should fail if an property specified in the XML is missing from the bean. Default is true for backward compatibility.
-
-
Constructor Detail
-
SetPropertiesRule
public SetPropertiesRule()
Base constructor.
-
SetPropertiesRule
public SetPropertiesRule(java.lang.String attributeName, java.lang.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 attributepropertyName
- to a property with this name
-
SetPropertiesRule
public SetPropertiesRule(java.lang.String[] attributeNames, java.lang.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 thecity
property and thealt-state
to thestate
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 theclassName
property. The attributeignore-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 mappropertyNames
- names of properties mapped to
-
SetPropertiesRule
public SetPropertiesRule(java.util.Map<java.lang.String,java.lang.String> aliases)
Constructor allows attribute->property mapping to be overriden.- Parameters:
aliases
- attribute->property mapping- Since:
- 3.0
-
-
Method Detail
-
begin
public void begin(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes) throws java.lang.Exception
This method is called when the beginning of a matching XML element is encountered.- Overrides:
begin
in classRule
- 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 namespacename
- the local name if the parser is namespace aware, or just the element name otherwiseattributes
- The attribute list of this element- Throws:
java.lang.Exception
- if any error occurs
-
addAlias
public void addAlias(java.lang.String attributeName, java.lang.String propertyName)
Add an additional attribute name to property name mapping. This is intended to be used from the xml rules.- Parameters:
attributeName
- the attribute name has to be mappedpropertyName
- the target property name
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
isIgnoreMissingProperty
public boolean isIgnoreMissingProperty()
Are attributes found in the xml without matching properties to be ignored?
If false, the parsing will interrupt with an
NoSuchMethodException
if a property specified in the XML is not found. The default is true.- Returns:
- true if skipping the unmatched attributes.
-
setIgnoreMissingProperty
public void setIgnoreMissingProperty(boolean ignoreMissingProperty)
Sets whether attributes found in the xml without matching properties should be ignored. If set to false, the parsing will throw anNoSuchMethodException
if an unmatched attribute is found. This allows to trap misspellings in the XML file.- Parameters:
ignoreMissingProperty
- false to stop the parsing on unmatched attributes.
-
-