Class BranchNodeCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bnc.object.branch.node.type.BranchNodeCaseBuilder
-
@Generated("mdsal-binding-generator") public class BranchNodeCaseBuilder extends Object
Class that buildsBranchNodeCase
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:
BranchNodeCase createBranchNodeCase(int fooXyzzy, int barBaz) { return new BranchNodeCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BranchNodeCase, 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:
BranchNodeCase
- 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 BranchNodeCaseBuilder()
Construct an empty builder.BranchNodeCaseBuilder(BranchNodeCase base)
Construct a builder initialized with state from specifiedBranchNodeCase
.BranchNodeCaseBuilder(BranchNodeObject arg)
Construct a new builder initialized from specifiedBranchNodeObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BranchNodeCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BranchNodeCase
build()
A newBranchNodeCase
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BranchNodeList
getBranchNodeList()
Return current value associated with the property corresponding toBranchNodeObject.getBranchNodeList()
.BranchNodeCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> augmentationType)
Remove an augmentation from this builder's product.BranchNodeCaseBuilder
setBranchNodeList(BranchNodeList value)
Set the property corresponding toBranchNodeObject.getBranchNodeList()
to the specified value.
-
-
-
Constructor Detail
-
BranchNodeCaseBuilder
public BranchNodeCaseBuilder()
Construct an empty builder.
-
BranchNodeCaseBuilder
public BranchNodeCaseBuilder(BranchNodeObject arg)
Construct a new builder initialized from specifiedBranchNodeObject
.- Parameters:
arg
- BranchNodeObject from which the builder should be initialized
-
BranchNodeCaseBuilder
public BranchNodeCaseBuilder(BranchNodeCase base)
Construct a builder initialized with state from specifiedBranchNodeCase
.- Parameters:
base
- BranchNodeCase 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
-
getBranchNodeList
public BranchNodeList getBranchNodeList()
Return current value associated with the property corresponding toBranchNodeObject.getBranchNodeList()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> 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
-
setBranchNodeList
public BranchNodeCaseBuilder setBranchNodeList(BranchNodeList value)
Set the property corresponding toBranchNodeObject.getBranchNodeList()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BranchNodeCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase> 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 BranchNodeCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BranchNodeCase>> 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 BranchNodeCase build()
A newBranchNodeCase
instance.- Returns:
- A new
BranchNodeCase
instance.
-
-