Class NodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.topology.stats.rpc.rev190321.get.stats.output.topology.NodeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Node>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Node,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NodeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Node>
Class that buildsNode
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:
Node createNode(int fooXyzzy, int barBaz) { return new NodeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Node, 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 opportunities, 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:
Node
,Builder
-
-
Constructor Summary
Constructors Constructor Description NodeBuilder()
NodeBuilder(PcepSessionStateGrouping arg)
NodeBuilder(Node base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Node> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Node>>
E$$augmentation(Class<E$$> augmentationType)
Node
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId
getNodeId()
PcepSessionState
getPcepSessionState()
NodeKey
key()
NodeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Node>> augmentationType)
Remove an augmentation from this builder's product.NodeBuilder
setNodeId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
NodeBuilder
setPcepSessionState(PcepSessionState value)
NodeBuilder
withKey(NodeKey key)
-
-
-
Constructor Detail
-
NodeBuilder
public NodeBuilder()
-
NodeBuilder
public NodeBuilder(PcepSessionStateGrouping arg)
-
NodeBuilder
public NodeBuilder(Node base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- PcepSessionStateGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public NodeKey key()
-
getNodeId
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNodeId()
-
getPcepSessionState
public PcepSessionState getPcepSessionState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Node>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NodeBuilder withKey(NodeKey key)
-
setNodeId
public NodeBuilder setNodeId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
setPcepSessionState
public NodeBuilder setPcepSessionState(PcepSessionState value)
-
addAugmentation
public NodeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.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
-
removeAugmentation
public NodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.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 interfaceorg.opendaylight.yangtools.concepts.Builder<Node>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Node,IllegalArgumentException>
-
-