Class FlowspecIpv6RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.ipv6.routes.FlowspecIpv6RoutesBuilder
-
@Generated("mdsal-binding-generator") public class FlowspecIpv6RoutesBuilder extends Object
Class that buildsFlowspecIpv6Routes
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:
FlowspecIpv6Routes createFlowspecIpv6Routes(int fooXyzzy, int barBaz) { return new FlowspecIpv6RoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowspecIpv6Routes, 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 opportunities, 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:
FlowspecIpv6Routes
- 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
-
-
Constructor Summary
Constructors Constructor Description FlowspecIpv6RoutesBuilder()
Construct an empty builder.FlowspecIpv6RoutesBuilder(FlowspecIpv6Routes base)
Construct a builder initialized with state from specifiedFlowspecIpv6Routes
.FlowspecIpv6RoutesBuilder(FlowspecIpv6Route arg)
Construct a new builder initialized from specifiedFlowspecIpv6Route
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowspecIpv6RoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowspecIpv6Routes
build()
A newFlowspecIpv6Routes
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<FlowspecRouteKey,FlowspecRoute>
getFlowspecRoute()
Return current value associated with the property corresponding toFlowspecIpv6Route.getFlowspecRoute()
.FlowspecIpv6RoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes>> augmentationType)
Remove an augmentation from this builder's product.FlowspecIpv6RoutesBuilder
setFlowspecRoute(Map<FlowspecRouteKey,FlowspecRoute> values)
Set the property corresponding toFlowspecIpv6Route.getFlowspecRoute()
to the specified value.
-
-
-
Constructor Detail
-
FlowspecIpv6RoutesBuilder
public FlowspecIpv6RoutesBuilder()
Construct an empty builder.
-
FlowspecIpv6RoutesBuilder
public FlowspecIpv6RoutesBuilder(FlowspecIpv6Route arg)
Construct a new builder initialized from specifiedFlowspecIpv6Route
.- Parameters:
arg
- FlowspecIpv6Route from which the builder should be initialized
-
FlowspecIpv6RoutesBuilder
public FlowspecIpv6RoutesBuilder(FlowspecIpv6Routes base)
Construct a builder initialized with state from specifiedFlowspecIpv6Routes
.- Parameters:
base
- FlowspecIpv6Routes from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getFlowspecRoute
public Map<FlowspecRouteKey,FlowspecRoute> getFlowspecRoute()
Return current value associated with the property corresponding toFlowspecIpv6Route.getFlowspecRoute()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setFlowspecRoute
public FlowspecIpv6RoutesBuilder setFlowspecRoute(Map<FlowspecRouteKey,FlowspecRoute> values)
Set the property corresponding toFlowspecIpv6Route.getFlowspecRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public FlowspecIpv6RoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes> 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 FlowspecIpv6RoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecIpv6Routes>> 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 @NonNull FlowspecIpv6Routes build()
A newFlowspecIpv6Routes
instance.- Returns:
- A new
FlowspecIpv6Routes
instance.
-
-