Class IfIndexesTunnelMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.IfIndexesTunnelMapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IfIndexesTunnelMap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexesTunnelMap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IfIndexesTunnelMapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IfIndexesTunnelMap>
Class that buildsIfIndexesTunnelMapBuilder
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:
IfIndexesTunnelMapBuilder createTarget(int fooXyzzy, int barBaz) { return new IfIndexesTunnelMapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IfIndexesTunnelMapBuilder, 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:
IfIndexesTunnelMapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IfIndexesTunnelMapBuilder()
IfIndexesTunnelMapBuilder(IfIndexesTunnelMap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IfIndexesTunnelMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IfIndexesTunnelMap
build()
java.util.Map<IfIndexTunnelKey,IfIndexTunnel>
getIfIndexTunnel()
IfIndexesTunnelMapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap>> augmentationType)
Remove an augmentation from this builder's product.IfIndexesTunnelMapBuilder
setIfIndexTunnel(java.util.List<IfIndexTunnel> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfIndexTunnel(Map)
instead.IfIndexesTunnelMapBuilder
setIfIndexTunnel(java.util.Map<IfIndexTunnelKey,IfIndexTunnel> values)
-
-
-
Constructor Detail
-
IfIndexesTunnelMapBuilder
public IfIndexesTunnelMapBuilder()
-
IfIndexesTunnelMapBuilder
public IfIndexesTunnelMapBuilder(IfIndexesTunnelMap base)
-
-
Method Detail
-
getIfIndexTunnel
public java.util.Map<IfIndexTunnelKey,IfIndexTunnel> getIfIndexTunnel()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIfIndexTunnel
public IfIndexesTunnelMapBuilder setIfIndexTunnel(java.util.Map<IfIndexTunnelKey,IfIndexTunnel> values)
-
setIfIndexTunnel
@Deprecated(forRemoval=true) public IfIndexesTunnelMapBuilder setIfIndexTunnel(java.util.List<IfIndexTunnel> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIfIndexTunnel(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 IfIndexesTunnelMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap> 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 IfIndexesTunnelMapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexesTunnelMap>> 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 IfIndexesTunnelMap build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IfIndexesTunnelMap>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexesTunnelMap,java.lang.IllegalArgumentException>
-
-