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