Class NodeConnectorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NodeConnector>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NodeConnector,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NodeConnectorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NodeConnector>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description NodeConnectorBuilder()
NodeConnectorBuilder(NodeConnector base)
NodeConnectorBuilder(NodeConnector arg)
-
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)
NodeConnector
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NodeConnectorId
getId()
NodeConnectorKey
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)
NodeConnectorBuilder
withKey(NodeConnectorKey key)
-
-
-
Constructor Detail
-
NodeConnectorBuilder
public NodeConnectorBuilder()
-
NodeConnectorBuilder
public NodeConnectorBuilder(NodeConnector arg)
-
NodeConnectorBuilder
public NodeConnectorBuilder(NodeConnector 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnector
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public NodeConnectorKey key()
-
getId
public NodeConnectorId getId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NodeConnector>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NodeConnectorBuilder withKey(NodeConnectorKey key)
-
setId
public NodeConnectorBuilder setId(NodeConnectorId value)
-
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 NodeConnector build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NodeConnector>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NodeConnector,IllegalArgumentException>
-
-