Class L3nexthopBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3nexthop.rev150409.L3nexthopBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3nexthop>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3nexthop,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class L3nexthopBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<L3nexthop>
Class that buildsL3nexthopBuilder
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:
L3nexthopBuilder createTarget(int fooXyzzy, int barBaz) { return new L3nexthopBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3nexthopBuilder, 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:
L3nexthopBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3nexthopBuilder()
L3nexthopBuilder(L3nexthop base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L3nexthopBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
L3nexthop
build()
java.util.Map<TunnelNexthopsKey,TunnelNexthops>
getTunnelNexthops()
java.util.Map<VpnNexthopsKey,VpnNexthops>
getVpnNexthops()
L3nexthopBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop>> augmentationType)
Remove an augmentation from this builder's product.L3nexthopBuilder
setTunnelNexthops(java.util.List<TunnelNexthops> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelNexthops(Map)
instead.L3nexthopBuilder
setTunnelNexthops(java.util.Map<TunnelNexthopsKey,TunnelNexthops> values)
L3nexthopBuilder
setVpnNexthops(java.util.List<VpnNexthops> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnNexthops(Map)
instead.L3nexthopBuilder
setVpnNexthops(java.util.Map<VpnNexthopsKey,VpnNexthops> values)
-
-
-
Constructor Detail
-
L3nexthopBuilder
public L3nexthopBuilder()
-
L3nexthopBuilder
public L3nexthopBuilder(L3nexthop base)
-
-
Method Detail
-
getTunnelNexthops
public java.util.Map<TunnelNexthopsKey,TunnelNexthops> getTunnelNexthops()
-
getVpnNexthops
public java.util.Map<VpnNexthopsKey,VpnNexthops> getVpnNexthops()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setTunnelNexthops
public L3nexthopBuilder setTunnelNexthops(java.util.Map<TunnelNexthopsKey,TunnelNexthops> values)
-
setTunnelNexthops
@Deprecated(forRemoval=true) public L3nexthopBuilder setTunnelNexthops(java.util.List<TunnelNexthops> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTunnelNexthops(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
-
setVpnNexthops
public L3nexthopBuilder setVpnNexthops(java.util.Map<VpnNexthopsKey,VpnNexthops> values)
-
setVpnNexthops
@Deprecated(forRemoval=true) public L3nexthopBuilder setVpnNexthops(java.util.List<VpnNexthops> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVpnNexthops(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 L3nexthopBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop> 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 L3nexthopBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3nexthop>> 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
-
-