Class LabeledUnicastIpv6RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.labeled.unicast.ipv6.routes.LabeledUnicastIpv6RoutesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LabeledUnicastIpv6Routes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LabeledUnicastIpv6Routes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LabeledUnicastIpv6RoutesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LabeledUnicastIpv6Routes>
Class that buildsLabeledUnicastIpv6RoutesBuilder
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:
LabeledUnicastIpv6RoutesBuilder createTarget(int fooXyzzy, int barBaz) { return new LabeledUnicastIpv6RoutesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LabeledUnicastIpv6RoutesBuilder, 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:
LabeledUnicastIpv6RoutesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LabeledUnicastIpv6RoutesBuilder()
LabeledUnicastIpv6RoutesBuilder(LabeledUnicastIpv6Routes base)
LabeledUnicastIpv6RoutesBuilder(LabeledUnicastRoutesList arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description LabeledUnicastIpv6RoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes>>
E$$augmentation(Class<E$$> augmentationType)
LabeledUnicastIpv6Routes
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<LabeledUnicastRouteKey,LabeledUnicastRoute>
getLabeledUnicastRoute()
LabeledUnicastIpv6RoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes>> augmentationType)
Remove an augmentation from this builder's product.LabeledUnicastIpv6RoutesBuilder
setLabeledUnicastRoute(List<LabeledUnicastRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabeledUnicastRoute(Map)
instead.LabeledUnicastIpv6RoutesBuilder
setLabeledUnicastRoute(Map<LabeledUnicastRouteKey,LabeledUnicastRoute> values)
-
-
-
Constructor Detail
-
LabeledUnicastIpv6RoutesBuilder
public LabeledUnicastIpv6RoutesBuilder()
-
LabeledUnicastIpv6RoutesBuilder
public LabeledUnicastIpv6RoutesBuilder(LabeledUnicastRoutesList arg)
-
LabeledUnicastIpv6RoutesBuilder
public LabeledUnicastIpv6RoutesBuilder(LabeledUnicastIpv6Routes base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.LabeledUnicastRoutesList
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLabeledUnicastRoute
public Map<LabeledUnicastRouteKey,LabeledUnicastRoute> getLabeledUnicastRoute()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes>> E$$ augmentation(Class<E$$> augmentationType)
-
setLabeledUnicastRoute
public LabeledUnicastIpv6RoutesBuilder setLabeledUnicastRoute(Map<LabeledUnicastRouteKey,LabeledUnicastRoute> values)
-
setLabeledUnicastRoute
@Deprecated(forRemoval=true) public LabeledUnicastIpv6RoutesBuilder setLabeledUnicastRoute(List<LabeledUnicastRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabeledUnicastRoute(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:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public LabeledUnicastIpv6RoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public LabeledUnicastIpv6RoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastIpv6Routes>> 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 LabeledUnicastIpv6Routes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LabeledUnicastIpv6Routes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LabeledUnicastIpv6Routes,IllegalArgumentException>
-
-