Class L3vpnIpv6MulticastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.l3vpn.ipv6.multicast.group.L3vpnIpv6MulticastBuilder
-
@Generated("mdsal-binding-generator") public class L3vpnIpv6MulticastBuilder extends Object
Class that buildsL3vpnIpv6Multicast
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:
L3vpnIpv6Multicast createL3vpnIpv6Multicast(int fooXyzzy, int barBaz) { return new L3vpnIpv6MulticastBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3vpnIpv6Multicast, 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:
L3vpnIpv6Multicast
- 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 L3vpnIpv6MulticastBuilder()
Construct an empty builder.L3vpnIpv6MulticastBuilder(AllAfiSafiCommon arg)
Construct a new builder initialized from specifiedAllAfiSafiCommon
.L3vpnIpv6MulticastBuilder(L3vpnIpv6Multicast base)
Construct a builder initialized with state from specifiedL3vpnIpv6Multicast
.L3vpnIpv6MulticastBuilder(L3vpnIpv4Ipv6MulticastCommon arg)
Construct a new builder initialized from specifiedL3vpnIpv4Ipv6MulticastCommon
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description L3vpnIpv6MulticastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull L3vpnIpv6Multicast
build()
A newL3vpnIpv6Multicast
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PrefixLimit
getPrefixLimit()
Return current value associated with the property corresponding toAllAfiSafiCommon.getPrefixLimit()
.L3vpnIpv6MulticastBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast>> augmentationType)
Remove an augmentation from this builder's product.L3vpnIpv6MulticastBuilder
setPrefixLimit(PrefixLimit value)
Set the property corresponding toAllAfiSafiCommon.getPrefixLimit()
to the specified value.
-
-
-
Constructor Detail
-
L3vpnIpv6MulticastBuilder
public L3vpnIpv6MulticastBuilder()
Construct an empty builder.
-
L3vpnIpv6MulticastBuilder
public L3vpnIpv6MulticastBuilder(L3vpnIpv4Ipv6MulticastCommon arg)
Construct a new builder initialized from specifiedL3vpnIpv4Ipv6MulticastCommon
.- Parameters:
arg
- L3vpnIpv4Ipv6MulticastCommon from which the builder should be initialized
-
L3vpnIpv6MulticastBuilder
public L3vpnIpv6MulticastBuilder(AllAfiSafiCommon arg)
Construct a new builder initialized from specifiedAllAfiSafiCommon
.- Parameters:
arg
- AllAfiSafiCommon from which the builder should be initialized
-
L3vpnIpv6MulticastBuilder
public L3vpnIpv6MulticastBuilder(L3vpnIpv6Multicast base)
Construct a builder initialized with state from specifiedL3vpnIpv6Multicast
.- Parameters:
base
- L3vpnIpv6Multicast 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
-
getPrefixLimit
public PrefixLimit getPrefixLimit()
Return current value associated with the property corresponding toAllAfiSafiCommon.getPrefixLimit()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast>> 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
-
setPrefixLimit
public L3vpnIpv6MulticastBuilder setPrefixLimit(PrefixLimit value)
Set the property corresponding toAllAfiSafiCommon.getPrefixLimit()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public L3vpnIpv6MulticastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast> 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 L3vpnIpv6MulticastBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnIpv6Multicast>> 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 L3vpnIpv6Multicast build()
A newL3vpnIpv6Multicast
instance.- Returns:
- A new
L3vpnIpv6Multicast
instance.
-
-