Class NestedPropertiesBuilder
- java.lang.Object
-
- org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder<SetNestedPropertiesRule>
-
- org.apache.commons.digester3.binder.NestedPropertiesBuilder
-
- All Implemented Interfaces:
RuleProvider<SetNestedPropertiesRule>
public final class NestedPropertiesBuilder extends AbstractBackToLinkedRuleBuilder<SetNestedPropertiesRule>
Builder chained when invokingLinkedRuleBuilder.setNestedProperties()
.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowUnknownChildElements
private java.util.Map<java.lang.String,java.lang.String>
elementNames
private boolean
trimData
-
Constructor Summary
Constructors Constructor Description NestedPropertiesBuilder(java.lang.String keyPattern, java.lang.String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AddAliasBuilder<NestedPropertiesBuilder>
addAlias(java.lang.String elementName)
Allows element2property mapping to be overridden.NestedPropertiesBuilder
addAlias(java.lang.String elementName, java.lang.String propertyName)
Deprecated.NestedPropertiesBuilder
allowUnknownChildElements(boolean allowUnknownChildElements)
Determines whether an error is reported when a nested element is encountered for which there is no corresponding property-setter method.protected SetNestedPropertiesRule
createRule()
Provides an instance ofRule
.NestedPropertiesBuilder
ignoreElement(java.lang.String elementName)
Allows ignore a matching element.NestedPropertiesBuilder
trimData(boolean trimData)
When set to true, any text within child elements will have leading and trailing whitespace removed before assignment to the target object.-
Methods inherited from class org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder
get, getNamespaceURI, getPattern, reportError, then
-
-
-
-
Constructor Detail
-
NestedPropertiesBuilder
NestedPropertiesBuilder(java.lang.String keyPattern, java.lang.String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)
-
-
Method Detail
-
ignoreElement
public NestedPropertiesBuilder ignoreElement(java.lang.String elementName)
Allows ignore a matching element.- Parameters:
elementName
- The child xml element to be ignored- Returns:
- this builder instance
-
addAlias
@Deprecated public NestedPropertiesBuilder addAlias(java.lang.String elementName, java.lang.String propertyName)
Deprecated.Allows element2property mapping to be overridden.- Parameters:
elementName
- The child xml element to matchpropertyName
- The java bean property to be assigned the value- Returns:
- this builder instance
-
addAlias
public AddAliasBuilder<NestedPropertiesBuilder> addAlias(java.lang.String elementName)
Allows element2property mapping to be overridden.- Parameters:
elementName
- The child xml element to match- Returns:
- the property alias builder
- Since:
- 3.2
-
trimData
public NestedPropertiesBuilder trimData(boolean trimData)
When set to true, any text within child elements will have leading and trailing whitespace removed before assignment to the target object.- Parameters:
trimData
- Flag to set any text within child elements will have leading and trailing whitespace removed- Returns:
- this builder instance
-
allowUnknownChildElements
public NestedPropertiesBuilder allowUnknownChildElements(boolean allowUnknownChildElements)
Determines whether an error is reported when a nested element is encountered for which there is no corresponding property-setter method.- Parameters:
allowUnknownChildElements
- flag to ignore any child element for which there is no corresponding object property- Returns:
- this builder instance
-
createRule
protected SetNestedPropertiesRule createRule()
Provides an instance ofRule
. Must never return null.- Specified by:
createRule
in classAbstractBackToLinkedRuleBuilder<SetNestedPropertiesRule>
- Returns:
- an instance of
Rule
. - See Also:
AbstractBackToLinkedRuleBuilder.get()
-
-