Class SetPropertiesBuilder

java.lang.Object
org.apache.commons.digester3.binder.SetPropertiesBuilder
All Implemented Interfaces:
RuleProvider<SetPropertiesRule>
public final class SetPropertiesBuilder extends Object
Builder chained when invoking LinkedRuleBuilder.setProperties().

  • Method Details

    • addAlias

      @Deprecated public SetPropertiesBuilder addAlias(String attributeName, String propertyName)
      Deprecated.
      Add an additional attribute name to property name mapping.
      Parameters:
      attributeName - The attribute to match
      propertyName - The java bean property to be assigned the value
      Returns:
      this builder instance

    • addAlias

      public AddAliasBuilder<SetPropertiesBuilder> addAlias(String attributeName)
      Add an additional attribute name to property name mapping.
      Parameters:
      attributeName - The attribute to match
      Returns:
      the property alias builder
      Since:
      3.2

    • ignoreAttribute

      public SetPropertiesBuilder ignoreAttribute(String attributeName)
      Add an attribute name to the ignore list.
      Parameters:
      attributeName - The attribute to match has to be ignored
      Returns:
      this builder instance

    • ignoreMissingProperty

      public SetPropertiesBuilder ignoreMissingProperty(boolean ignoreMissingProperty)
      Sets whether attributes found in the XML without matching properties should be ignored. If set to false, the parsing will throw an NoSuchMethodException 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
      Returns:
      this builder instance

    • createRule

      protected SetPropertiesRule createRule()
      Provides an instance of Rule. Must never return null.
      Returns:
      an instance of Rule.
      See Also:

    • then

      public final LinkedRuleBuilder then()
      Come back to the main LinkedRuleBuilder.
      Returns:
      the main LinkedRuleBuilder

    • getNamespaceURI

      public final String getNamespaceURI()
      Returns the namespace URI for which this Rule is relevant, if any.
      Returns:
      The namespace URI for which this Rule is relevant, if any

    • get

      public final SetPropertiesRule get()
      Provides an instance of Rule. Must never return null.
      Specified by:
      get in interface RuleProvider<R extends Rule>
      Returns:
      an instance of Rule.

    • reportError

      protected final void reportError(String methodChain, String message)

    • getPattern

      public final String getPattern()
      Returns the rule pattern associated to this builder.
      Returns:
      The rule pattern associated to this builder