Class VpnNexthopsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.l3nexthop.VpnNexthopsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnNexthops>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthops,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnNexthopsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VpnNexthops>
Class that buildsVpnNexthopsBuilder
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:
VpnNexthopsBuilder createTarget(int fooXyzzy, int barBaz) { return new VpnNexthopsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnNexthopsBuilder, 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:
VpnNexthopsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnNexthopsBuilder()
VpnNexthopsBuilder(VpnNexthops base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VpnNexthopsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VpnNexthops
build()
org.opendaylight.yangtools.yang.common.Uint32
getVpnId()
java.util.Map<VpnNexthopKey,VpnNexthop>
getVpnNexthop()
VpnNexthopsKey
key()
VpnNexthopsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops>> augmentationType)
Remove an augmentation from this builder's product.VpnNexthopsBuilder
setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnId(Uint32)
instead.VpnNexthopsBuilder
setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
VpnNexthopsBuilder
setVpnNexthop(java.util.List<VpnNexthop> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnNexthop(Map)
instead.VpnNexthopsBuilder
setVpnNexthop(java.util.Map<VpnNexthopKey,VpnNexthop> values)
VpnNexthopsBuilder
withKey(VpnNexthopsKey key)
-
-
-
Constructor Detail
-
VpnNexthopsBuilder
public VpnNexthopsBuilder()
-
VpnNexthopsBuilder
public VpnNexthopsBuilder(VpnNexthops base)
-
-
Method Detail
-
key
public VpnNexthopsKey key()
-
getVpnId
public org.opendaylight.yangtools.yang.common.Uint32 getVpnId()
-
getVpnNexthop
public java.util.Map<VpnNexthopKey,VpnNexthop> getVpnNexthop()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VpnNexthopsBuilder withKey(VpnNexthopsKey key)
-
setVpnId
public VpnNexthopsBuilder setVpnId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVpnId
@Deprecated(forRemoval=true) public VpnNexthopsBuilder setVpnId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVpnNexthop
public VpnNexthopsBuilder setVpnNexthop(java.util.Map<VpnNexthopKey,VpnNexthop> values)
-
setVpnNexthop
@Deprecated(forRemoval=true) public VpnNexthopsBuilder setVpnNexthop(java.util.List<VpnNexthop> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnNexthop(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 VpnNexthopsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops> 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 VpnNexthopsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnNexthops>> 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 VpnNexthops build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnNexthops>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnNexthops,java.lang.IllegalArgumentException>
-
-