Class BidirPimTreeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.pmsi.tunnel.tunnel.identifier.BidirPimTreeBuilder
-
@Generated("mdsal-binding-generator") public class BidirPimTreeBuilder extends Object
Class that buildsBidirPimTree
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:
BidirPimTree createBidirPimTree(int fooXyzzy, int barBaz) { return new BidirPimTreeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BidirPimTree, 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:
BidirPimTree
- 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 BidirPimTreeBuilder()
Construct an empty builder.BidirPimTreeBuilder(BidirPimTree base)
Construct a builder initialized with state from specifiedBidirPimTree
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BidirPimTreeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BidirPimTree
build()
A newBidirPimTree
instance.BidirPimTree
getBidirPimTree()
Return current value associated with the property corresponding toBidirPimTree.getBidirPimTree()
.BidirPimTreeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>> augmentationType)
Remove an augmentation from this builder's product.BidirPimTreeBuilder
setBidirPimTree(BidirPimTree value)
Set the property corresponding toBidirPimTree.getBidirPimTree()
to the specified value.
-
-
-
Constructor Detail
-
BidirPimTreeBuilder
public BidirPimTreeBuilder()
Construct an empty builder.
-
BidirPimTreeBuilder
public BidirPimTreeBuilder(BidirPimTree base)
Construct a builder initialized with state from specifiedBidirPimTree
.- Parameters:
base
- BidirPimTree from which the builder should be initialized
-
-
Method Detail
-
getBidirPimTree
public BidirPimTree getBidirPimTree()
Return current value associated with the property corresponding toBidirPimTree.getBidirPimTree()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>> 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
-
setBidirPimTree
public BidirPimTreeBuilder setBidirPimTree(BidirPimTree value)
Set the property corresponding toBidirPimTree.getBidirPimTree()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BidirPimTreeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree> 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 BidirPimTreeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>> 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 BidirPimTree build()
A newBidirPimTree
instance.- Returns:
- A new
BidirPimTree
instance.
-
-