Class NodeUpdatedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeUpdatedBuilder
-
- All Implemented Interfaces:
Builder<NodeUpdated>
,CheckedBuilder<NodeUpdated,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class NodeUpdatedBuilder extends Object implements Builder<NodeUpdated>
Class that buildsNodeUpdatedBuilder
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:
NodeUpdatedBuilder createTarget(int fooXyzzy, int barBaz) { return new NodeUpdatedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NodeUpdatedBuilder, 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:
NodeUpdatedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NodeUpdatedBuilder()
NodeUpdatedBuilder(Node arg)
NodeUpdatedBuilder(NodeUpdated base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NodeUpdatedBuilder
addAugmentation(Augmentation<NodeUpdated> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<NodeUpdated>>
E$$augmentation(Class<E$$> augmentationType)
NodeUpdated
build()
void
fieldsFrom(DataObject arg)
Set fields from given grouping argument.NodeId
getId()
Map<NodeConnectorKey,NodeConnector>
getNodeConnector()
NodeRef
getNodeRef()
NodeUpdatedBuilder
removeAugmentation(Class<? extends Augmentation<NodeUpdated>> augmentationType)
Remove an augmentation from this builder's product.NodeUpdatedBuilder
setId(NodeId value)
NodeUpdatedBuilder
setNodeConnector(List<NodeConnector> values)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link #setNodeConnector(Map)} instead.NodeUpdatedBuilder
setNodeConnector(Map<NodeConnectorKey,NodeConnector> values)
NodeUpdatedBuilder
setNodeRef(NodeRef value)
-
-
-
Constructor Detail
-
NodeUpdatedBuilder
public NodeUpdatedBuilder()
-
NodeUpdatedBuilder
public NodeUpdatedBuilder(Node arg)
-
NodeUpdatedBuilder
public NodeUpdatedBuilder(NodeUpdated base)
-
-
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
-
getId
public NodeId getId()
-
getNodeConnector
public Map<NodeConnectorKey,NodeConnector> getNodeConnector()
-
getNodeRef
public NodeRef getNodeRef()
-
augmentation
public <E$$ extends Augmentation<NodeUpdated>> E$$ augmentation(Class<E$$> augmentationType)
-
setId
public NodeUpdatedBuilder setId(NodeId value)
-
setNodeConnector
public NodeUpdatedBuilder setNodeConnector(Map<NodeConnectorKey,NodeConnector> values)
-
setNodeConnector
@Deprecated(forRemoval=true) public NodeUpdatedBuilder 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
-
setNodeRef
public NodeUpdatedBuilder setNodeRef(NodeRef value)
-
addAugmentation
public NodeUpdatedBuilder addAugmentation(Augmentation<NodeUpdated> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NodeUpdatedBuilder removeAugmentation(Class<? extends Augmentation<NodeUpdated>> 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 NodeUpdated build()
- Specified by:
build
in interfaceBuilder<NodeUpdated>
- Specified by:
build
in interfaceCheckedBuilder<NodeUpdated,IllegalArgumentException>
-
-