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.bidir.pim.tree.BidirPimTreeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BidirPimTree>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BidirPimTree,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BidirPimTreeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BidirPimTree>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description BidirPimTreeBuilder()
BidirPimTreeBuilder(PAddressPMulticastGroup arg)
BidirPimTreeBuilder(BidirPimTree base)
-
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)
BidirPimTree
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getPAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getPMulticastGroup()
BidirPimTreeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>> augmentationType)
Remove an augmentation from this builder's product.BidirPimTreeBuilder
setPAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
BidirPimTreeBuilder
setPMulticastGroup(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
-
-
Constructor Detail
-
BidirPimTreeBuilder
public BidirPimTreeBuilder()
-
BidirPimTreeBuilder
public BidirPimTreeBuilder(PAddressPMulticastGroup arg)
-
BidirPimTreeBuilder
public BidirPimTreeBuilder(BidirPimTree 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:- PAddressPMulticastGroup
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getPAddress()
-
getPMulticastGroup
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getPMulticastGroup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BidirPimTree>> E$$ augmentation(Class<E$$> augmentationType)
-
setPAddress
public BidirPimTreeBuilder setPAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setPMulticastGroup
public BidirPimTreeBuilder setPMulticastGroup(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
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 BidirPimTree build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BidirPimTree>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BidirPimTree,IllegalArgumentException>
-
-