|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.digester.Rule org.apache.commons.digester.SetPropertiesRule
public class SetPropertiesRule
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 inherited from class org.apache.commons.digester.Rule |
---|
digester, namespaceURI |
Constructor Summary | |
---|---|
SetPropertiesRule()
Base constructor. |
|
SetPropertiesRule(Digester digester)
Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method.
Use SetPropertiesRule() instead. |
|
SetPropertiesRule(String[] attributeNames,
String[] propertyNames)
Constructor allows attribute->property mapping to be overriden. |
|
SetPropertiesRule(String attributeName,
String propertyName)
Convenience constructor overrides the mapping for just one property. |
Method Summary | |
---|---|
void |
addAlias(String attributeName,
String propertyName)
Add an additional attribute name to property name mapping. |
void |
begin(Attributes attributes)
Process the beginning of this element. |
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. |
String |
toString()
Render a printable version of this Rule. |
Methods inherited from class org.apache.commons.digester.Rule |
---|
begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SetPropertiesRule(Digester digester)
Digester.addRule(java.lang.String, org.apache.commons.digester.Rule)
method.
Use SetPropertiesRule()
instead.
digester
- The digester with which this rule is associatedpublic 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)
.
attributeName
- map this attributepropertyName
- to a property with this namepublic 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.
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"});
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"});
attributeNames
- names of attributes to mappropertyNames
- names of properties mapped toMethod Detail |
---|
public void begin(Attributes attributes) throws Exception
begin
in class Rule
attributes
- The attribute list of this element
Exception
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.
public String toString()
toString
in class Object
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.
public void setIgnoreMissingProperty(boolean ignoreMissingProperty)
NoSuchMethodException
if an unmatched
attribute is found. This allows to trap misspellings in the XML file.
ignoreMissingProperty
- false to stop the parsing on unmatched attributes.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |