org.apache.commons.digester.plugins.strategies: public class: FinderSetProperties

org.apache.commons.digester.plugins.strategies
public class: FinderSetProperties [javadoc | source]

java.lang.Object
   org.apache.commons.digester.plugins.RuleFinder
      org.apache.commons.digester.plugins.strategies.FinderSetProperties

A rule-finding algorithm which expects the user to specify whether "automatic property setting" is desired. If this class discovers that this is in fact the case for a declaration, then a RuleLoader is returned which, when invoked, adds a single SetPropertiesRule instance to the digester.

This allows ordinary JavaBean classes to be used as plugins, and have xml attributes be mapped to bean properties of the same name, without any custom plugin rules being created for them.

This RuleFinder is typically used as the last RuleFinder, so that automatic property setting only occurs if there is no other source of custom rules available.

since: 1.6 -

Field Summary
public static String	DFLT_PROPS_ATTR
public static String	DFLT_FALSEVAL

Constructor:

Constructor:
public FinderSetProperties() { this(DFLT_PROPS_ATTR, DFLT_FALSEVAL); } See #findLoader .
public FinderSetProperties(String propsAttr, String falseval) { this.propsAttr = propsAttr; this.falseval = falseval; } Create a rule-finder which will arrange for a SetPropertiesRule to be defined for each instance of a plugin, so that xml attributes map to bean properties. Param falseval will commonly be the string "false" for config files written in English. Parameters: `propsAttr` - must be non-null. `falseval` - must be non-null.

 public FinderSetProperties() {
    
        this(DFLT_PROPS_ATTR, DFLT_FALSEVAL);
}

See

#findLoader

 public FinderSetProperties(String propsAttr,
    String falseval) {
 
        this.propsAttr = propsAttr;
        this.falseval = falseval;
}

Param falseval will commonly be the string "false" for config files written in English.

Parameters:

propsAttr - must be non-null.

falseval - must be non-null.

Method from org.apache.commons.digester.plugins.strategies.FinderSetProperties Summary:
findLoader

Methods from org.apache.commons.digester.plugins.RuleFinder:
findLoader

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.digester.plugins.strategies.FinderSetProperties Detail:
public RuleLoader findLoader(Digester d, Class pluginClass, Properties p) { String state = p.getProperty(propsAttr); if ((state != null) && state.equals(falseval)) { // user has explicitly disabled automatic setting of properties. // this is not expected to be common, but allowed. return null; } return new LoaderSetProperties(); } Returns a RuleLoader unless the properties contain an entry with the name matching constructor param propsAttr, and the value matching what is in falseval. If no custom source of rules for a plugin is found, then the user almost always wants xml attributes to map to java bean properties, so this is the default behaviour unless the user explicitly indicates that they do not want a SetPropertiesRule to be provided for the plugged-in class. The returned object (when non-null) will add a SetPropertiesRule to the digester whenever its addRules method is invoked.

Method from org.apache.commons.digester.plugins.strategies.FinderSetProperties Detail:

 public RuleLoader findLoader(Digester d,
    Class pluginClass,
    Properties p) {
        String state = p.getProperty(propsAttr);
        if ((state != null)  && state.equals(falseval)) {
            // user has explicitly disabled automatic setting of properties.
            // this is not expected to be common, but allowed.
            return null;
        }
        return new LoaderSetProperties();
}

unless

If no custom source of rules for a plugin is found, then the user almost always wants xml attributes to map to java bean properties, so this is the default behaviour unless the user explicitly indicates that they do not want a SetPropertiesRule to be provided for the plugged-in class.

The returned object (when non-null) will add a SetPropertiesRule to the digester whenever its addRules method is invoked.