Class OriginalNodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.topology.view.rev131030.aggregate.node.OriginalNodeBuilder
-
- All Implemented Interfaces:
Builder<OriginalNode>
,CheckedBuilder<OriginalNode,IllegalArgumentException>
,Mutable
,MutationBehaviour<Mutable>
public class OriginalNodeBuilder extends Object implements Builder<OriginalNode>
Class that buildsOriginalNodeBuilder
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:
OriginalNodeBuilder createTarget(int fooXyzzy, int barBaz) { return new OriginalNodeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OriginalNodeBuilder, 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:
OriginalNodeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OriginalNodeBuilder()
OriginalNodeBuilder(OriginalNode base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OriginalNodeBuilder
addAugmentation(Augmentation<OriginalNode> augmentation)
Add an augmentation to this builder's product.<E$$ extends Augmentation<OriginalNode>>
E$$augmentation(Class<E$$> augmentationType)
OriginalNode
build()
NodeId
getNode()
TopologyId
getTopology()
OriginalNodeBuilder
removeAugmentation(Class<? extends Augmentation<OriginalNode>> augmentationType)
Remove an augmentation from this builder's product.OriginalNodeBuilder
setNode(NodeId value)
OriginalNodeBuilder
setTopology(TopologyId value)
-
-
-
Constructor Detail
-
OriginalNodeBuilder
public OriginalNodeBuilder()
-
OriginalNodeBuilder
public OriginalNodeBuilder(OriginalNode base)
-
-
Method Detail
-
getNode
public NodeId getNode()
-
getTopology
public TopologyId getTopology()
-
augmentation
public <E$$ extends Augmentation<OriginalNode>> E$$ augmentation(Class<E$$> augmentationType)
-
setNode
public OriginalNodeBuilder setNode(NodeId value)
-
setTopology
public OriginalNodeBuilder setTopology(TopologyId value)
-
addAugmentation
public OriginalNodeBuilder addAugmentation(Augmentation<OriginalNode> 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 OriginalNodeBuilder removeAugmentation(Class<? extends Augmentation<OriginalNode>> 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 OriginalNode build()
- Specified by:
build
in interfaceBuilder<OriginalNode>
- Specified by:
build
in interfaceCheckedBuilder<OriginalNode,IllegalArgumentException>
-
-