Class ImmutableNode.Builder
java.lang.Object
org.apache.commons.configuration2.tree.ImmutableNode.Builder
- Enclosing class:
- ImmutableNode
A builder class for creating instances of ImmutableNode
.
This class can be used to set all properties of an immutable node instance. Eventually call the create()
method to obtain the resulting instance.
Implementation note: This class is not thread-safe. It is intended to be used to define a single node instance only.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAttribute
(String name, Object value) Adds an attribute to this builder.addAttributes
(Map<String, ?> attrs) Adds all attributes of the given map to this builder.Adds a child node to this builder.addChildren
(Collection<? extends ImmutableNode> children) Adds multiple child nodes to this builder.create()
Creates a newImmutableNode
instance based on the properties set for this builder.Sets the name of the node to be created.Sets the value of the node to be created.
-
Constructor Details
-
Builder
public Builder()Creates a new instance ofBuilder
which does not contain any property definitions yet. -
Builder
Creates a new instance ofBuilder
and sets the number of expected child nodes. Using this constructor helps the class to create a properly sized list for the child nodes to be added.- Parameters:
childCount
- the number of child nodes
-
-
Method Details
-
addAttribute
Adds an attribute to this builder. The passed in attribute key and value are stored in an internal map. If there is already an attribute with this name, it is overridden.- Parameters:
name
- the attribute namevalue
- the attribute value- Returns:
- a reference to this object for method chaining
-
addAttributes
Adds all attributes of the given map to this builder. This method works likeaddAttribute(String, Object)
, but it allows setting multiple attributes at once.- Parameters:
attrs
- the map with attributes to be added (may be null- Returns:
- a reference to this object for method chaining
-
addChild
Adds a child node to this builder. The passed in node becomes a child of the newly created node. If it is null, it is ignored.- Parameters:
c
- the child node (must not be null)- Returns:
- a reference to this object for method chaining
-
addChildren
Adds multiple child nodes to this builder. This method works likeaddChild(ImmutableNode)
, but it allows setting a number of child nodes at once.- Parameters:
children
- a collection with the child nodes to be added- Returns:
- a reference to this object for method chaining
-
create
Creates a newImmutableNode
instance based on the properties set for this builder.- Returns:
- the newly created
ImmutableNode
-
name
Sets the name of the node to be created.- Parameters:
n
- the node name- Returns:
- a reference to this object for method chaining
-
value
Sets the value of the node to be created.- Parameters:
v
- the value- Returns:
- a reference to this object for method chaining
-