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