Class BgpAfIpv6VpnInstancesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.bgp.router.BgpAfIpv6VpnInstancesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpAfIpv6VpnInstances>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpAfIpv6VpnInstances,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BgpAfIpv6VpnInstancesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BgpAfIpv6VpnInstances>
Class that buildsBgpAfIpv6VpnInstancesBuilder
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:
BgpAfIpv6VpnInstancesBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpAfIpv6VpnInstancesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpAfIpv6VpnInstancesBuilder, 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 oportunities, 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:
BgpAfIpv6VpnInstancesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpAfIpv6VpnInstancesBuilder()
BgpAfIpv6VpnInstancesBuilder(BgpAfIpv6VpnInstances base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BgpAfIpv6VpnInstancesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BgpAfIpv6VpnInstances
build()
java.util.Map<BgpAfIpv6VpnInstanceKey,BgpAfIpv6VpnInstance>
getBgpAfIpv6VpnInstance()
BgpAfIpv6VpnInstancesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances>> augmentationType)
Remove an augmentation from this builder's product.BgpAfIpv6VpnInstancesBuilder
setBgpAfIpv6VpnInstance(java.util.List<BgpAfIpv6VpnInstance> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBgpAfIpv6VpnInstance(Map)
instead.BgpAfIpv6VpnInstancesBuilder
setBgpAfIpv6VpnInstance(java.util.Map<BgpAfIpv6VpnInstanceKey,BgpAfIpv6VpnInstance> values)
-
-
-
Constructor Detail
-
BgpAfIpv6VpnInstancesBuilder
public BgpAfIpv6VpnInstancesBuilder()
-
BgpAfIpv6VpnInstancesBuilder
public BgpAfIpv6VpnInstancesBuilder(BgpAfIpv6VpnInstances base)
-
-
Method Detail
-
getBgpAfIpv6VpnInstance
public java.util.Map<BgpAfIpv6VpnInstanceKey,BgpAfIpv6VpnInstance> getBgpAfIpv6VpnInstance()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setBgpAfIpv6VpnInstance
public BgpAfIpv6VpnInstancesBuilder setBgpAfIpv6VpnInstance(java.util.Map<BgpAfIpv6VpnInstanceKey,BgpAfIpv6VpnInstance> values)
-
setBgpAfIpv6VpnInstance
@Deprecated(forRemoval=true) public BgpAfIpv6VpnInstancesBuilder setBgpAfIpv6VpnInstance(java.util.List<BgpAfIpv6VpnInstance> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBgpAfIpv6VpnInstance(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
addAugmentation
public BgpAfIpv6VpnInstancesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public BgpAfIpv6VpnInstancesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpAfIpv6VpnInstances>> 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 BgpAfIpv6VpnInstances build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpAfIpv6VpnInstances>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpAfIpv6VpnInstances,java.lang.IllegalArgumentException>
-
-