Class FlowspecRoutesCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.bgp.rib.rib.loc.rib.tables.routes.FlowspecRoutesCaseBuilder
-
@Generated("mdsal-binding-generator") public class FlowspecRoutesCaseBuilder extends Object
Class that buildsFlowspecRoutesCase
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:
FlowspecRoutesCase createFlowspecRoutesCase(int fooXyzzy, int barBaz) { return new FlowspecRoutesCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowspecRoutesCase, 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:
FlowspecRoutesCase
- 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 FlowspecRoutesCaseBuilder()
Construct an empty builder.FlowspecRoutesCaseBuilder(FlowspecRoutesCase base)
Construct a builder initialized with state from specifiedFlowspecRoutesCase
.FlowspecRoutesCaseBuilder(FlowspecRoutes arg)
Construct a new builder initialized from specifiedFlowspecRoutes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowspecRoutesCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowspecRoutesCase
build()
A newFlowspecRoutesCase
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.FlowspecRoutes
getFlowspecRoutes()
Return current value associated with the property corresponding toFlowspecRoutes.getFlowspecRoutes()
.FlowspecRoutesCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase>> augmentationType)
Remove an augmentation from this builder's product.FlowspecRoutesCaseBuilder
setFlowspecRoutes(FlowspecRoutes value)
Set the property corresponding toFlowspecRoutes.getFlowspecRoutes()
to the specified value.
-
-
-
Constructor Detail
-
FlowspecRoutesCaseBuilder
public FlowspecRoutesCaseBuilder()
Construct an empty builder.
-
FlowspecRoutesCaseBuilder
public FlowspecRoutesCaseBuilder(FlowspecRoutes arg)
Construct a new builder initialized from specifiedFlowspecRoutes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.FlowspecRoutes from which the builder should be initialized
-
FlowspecRoutesCaseBuilder
public FlowspecRoutesCaseBuilder(FlowspecRoutesCase base)
Construct a builder initialized with state from specifiedFlowspecRoutesCase
.- Parameters:
base
- FlowspecRoutesCase 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
-
getFlowspecRoutes
public FlowspecRoutes getFlowspecRoutes()
Return current value associated with the property corresponding toFlowspecRoutes.getFlowspecRoutes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase>> 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
-
setFlowspecRoutes
public FlowspecRoutesCaseBuilder setFlowspecRoutes(FlowspecRoutes value)
Set the property corresponding toFlowspecRoutes.getFlowspecRoutes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowspecRoutesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase> 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 FlowspecRoutesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowspecRoutesCase>> 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 FlowspecRoutesCase build()
A newFlowspecRoutesCase
instance.- Returns:
- A new
FlowspecRoutesCase
instance.
-
-