Class FlowspecRoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.routes.FlowspecRoutesBuilder
-
@Generated("mdsal-binding-generator") public class FlowspecRoutesBuilder extends Object
Class that buildsFlowspecRoutes
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:
FlowspecRoutes createFlowspecRoutes(int fooXyzzy, int barBaz) { return new FlowspecRoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowspecRoutes, 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:
FlowspecRoutes
- 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 FlowspecRoutesBuilder()
Construct an empty builder.FlowspecRoutesBuilder(FlowspecRoutes base)
Construct a builder initialized with state from specifiedFlowspecRoutes
.FlowspecRoutesBuilder(FlowspecIpv4Route arg)
Construct a new builder initialized from specifiedFlowspecIpv4Route
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowspecRoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowspecRoutes
build()
A newFlowspecRoutes
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 toFlowspecIpv4Route.getFlowspecRoute()
.FlowspecRoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes>> augmentationType)
Remove an augmentation from this builder's product.FlowspecRoutesBuilder
setFlowspecRoute(Map<FlowspecRouteKey,FlowspecRoute> values)
Set the property corresponding toFlowspecIpv4Route.getFlowspecRoute()
to the specified value.
-
-
-
Constructor Detail
-
FlowspecRoutesBuilder
public FlowspecRoutesBuilder()
Construct an empty builder.
-
FlowspecRoutesBuilder
public FlowspecRoutesBuilder(FlowspecIpv4Route arg)
Construct a new builder initialized from specifiedFlowspecIpv4Route
.- Parameters:
arg
- FlowspecIpv4Route from which the builder should be initialized
-
FlowspecRoutesBuilder
public FlowspecRoutesBuilder(FlowspecRoutes base)
Construct a builder initialized with state from specifiedFlowspecRoutes
.- Parameters:
base
- FlowspecRoutes 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 toFlowspecIpv4Route.getFlowspecRoute()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes>> 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 FlowspecRoutesBuilder setFlowspecRoute(Map<FlowspecRouteKey,FlowspecRoute> values)
Set the property corresponding toFlowspecIpv4Route.getFlowspecRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public FlowspecRoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes> 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 FlowspecRoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutes>> 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 FlowspecRoutes build()
A newFlowspecRoutes
instance.- Returns:
- A new
FlowspecRoutes
instance.
-
-