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 invoking
LinkedRuleBuilder.setNestedProperties()
.- Since:
- 3.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionNestedPropertiesBuilder
(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder) -
Method Summary
Modifier and TypeMethodDescriptionAllows element2property mapping to be overridden.Deprecated.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
Provides an instance ofRule
.ignoreElement
(String elementName) Allows ignore a matching element.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
-
Field Details
-
elementNames
-
trimData
private boolean trimData -
allowUnknownChildElements
private boolean allowUnknownChildElements
-
-
Constructor Details
-
NestedPropertiesBuilder
NestedPropertiesBuilder(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)
-
-
Method Details
-
ignoreElement
Allows ignore a matching element.- Parameters:
elementName
- The child xml element to be ignored- Returns:
- this builder instance
-
addAlias
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
Allows element2property mapping to be overridden.- Parameters:
elementName
- The child xml element to match- Returns:
- the property alias builder
- Since:
- 3.2
-
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
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
Provides an instance ofRule
. Must never return null.- Specified by:
createRule
in classAbstractBackToLinkedRuleBuilder<SetNestedPropertiesRule>
- Returns:
- an instance of
Rule
. - See Also:
-