Class NodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder
-
- All Implemented Interfaces:
Builder<Node>
,CheckedBuilder<Node,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class NodeBuilder extends Object implements Builder<Node>
Class that buildsNodeBuilder
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
NodeBuilder createTarget(int fooXyzzy, int barBaz) { return new NodeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NodeBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization oportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
NodeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NodeBuilder()
NodeBuilder(Node arg)
NodeBuilder(Node base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NodeBuilder
addAugmentation(Class<? extends Augmentation<Node>> augmentationType, Augmentation<Node> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.NodeBuilder
addAugmentation(Augmentation<Node> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<Node>>
E$$augmentation(Class<E$$> augmentationType)
Node
build()
void
fieldsFrom(DataObject arg)
Set fields from given grouping argument.NodeId
getId()
Map<NodeConnectorKey,NodeConnector>
getNodeConnector()
NodeKey
key()
NodeBuilder
removeAugmentation(Class<? extends Augmentation<Node>> augmentationType)
Remove an augmentation from this builder's product.NodeBuilder
setId(NodeId value)
NodeBuilder
setNodeConnector(List<NodeConnector> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setNodeConnector(Map)} instead.NodeBuilder
setNodeConnector(Map<NodeConnectorKey,NodeConnector> values)
NodeBuilder
withKey(NodeKey key)
-
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Node
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public NodeKey key()
-
getId
public NodeId getId()
-
getNodeConnector
public Map<NodeConnectorKey,NodeConnector> getNodeConnector()
-
augmentation
public <E$$ extends Augmentation<Node>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NodeBuilder withKey(NodeKey key)
-
setId
public NodeBuilder setId(NodeId value)
-
setNodeConnector
public NodeBuilder setNodeConnector(Map<NodeConnectorKey,NodeConnector> values)
-
setNodeConnector
@Deprecated(forRemoval=true) public NodeBuilder setNodeConnector(List<NodeConnector> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setNodeConnector(Map)} instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public NodeBuilder addAugmentation(Augmentation<Node> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public NodeBuilder addAugmentation(Class<? extends Augmentation<Node>> augmentationType, Augmentation<Node> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public NodeBuilder removeAugmentation(Class<? extends Augmentation<Node>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public Node build()
- Specified by:
build
in interfaceBuilder<Node>
- Specified by:
build
in interfaceCheckedBuilder<Node,IllegalArgumentException>
-
-