Class NodeConnectorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder
-
@Generated("mdsal-binding-generator") public class NodeConnectorBuilder extends Object
Class that buildsNodeConnector
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:
NodeConnector createNodeConnector(int fooXyzzy, int barBaz) { return new NodeConnectorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NodeConnector, 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:
NodeConnector
- 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
-
-
Constructor Summary
Constructors Constructor Description NodeConnectorBuilder()
Construct an empty builder.NodeConnectorBuilder(NodeConnector base)
Construct a builder initialized with state from specifiedNodeConnector
.NodeConnectorBuilder(NodeConnector arg)
Construct a new builder initialized from specifiedNodeConnector
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodeConnectorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NodeConnector
build()
A newNodeConnector
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeConnectorId
getId()
Return current value associated with the property corresponding toNodeConnector.getId()
.NodeConnectorKey
key()
Return current value associated with the property corresponding toNodeConnector.key()
.NodeConnectorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector>> augmentationType)
Remove an augmentation from this builder's product.NodeConnectorBuilder
setId(NodeConnectorId value)
Set the property corresponding toNodeConnector.getId()
to the specified value.NodeConnectorBuilder
withKey(NodeConnectorKey key)
-
-
-
Constructor Detail
-
NodeConnectorBuilder
public NodeConnectorBuilder()
Construct an empty builder.
-
NodeConnectorBuilder
public NodeConnectorBuilder(NodeConnector arg)
Construct a new builder initialized from specifiedNodeConnector
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnector from which the builder should be initialized
-
NodeConnectorBuilder
public NodeConnectorBuilder(NodeConnector base)
Construct a builder initialized with state from specifiedNodeConnector
.- Parameters:
base
- NodeConnector from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public NodeConnectorKey key()
Return current value associated with the property corresponding toNodeConnector.key()
.- Returns:
- current value
-
getId
public NodeConnectorId getId()
Return current value associated with the property corresponding toNodeConnector.getId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public NodeConnectorBuilder withKey(NodeConnectorKey key)
-
setId
public NodeConnectorBuilder setId(NodeConnectorId value)
Set the property corresponding toNodeConnector.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NodeConnectorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector> 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 NodeConnectorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector>> 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 @NonNull NodeConnector build()
A newNodeConnector
instance.- Returns:
- A new
NodeConnector
instance.
-
-