Class FlowspecBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.FlowspecBuilder
-
@Generated("mdsal-binding-generator") public class FlowspecBuilder extends Object
Class that buildsFlowspec
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:
Flowspec createFlowspec(int fooXyzzy, int barBaz) { return new FlowspecBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Flowspec, 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:
Flowspec
- 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 FlowspecBuilder()
Construct an empty builder.FlowspecBuilder(Flowspec base)
Construct a builder initialized with state from specifiedFlowspec
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowspecBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Flowspec
build()
A newFlowspec
instance.FlowspecType
getFlowspecType()
Return current value associated with the property corresponding toFlowspec.getFlowspecType()
.FlowspecBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec>> augmentationType)
Remove an augmentation from this builder's product.FlowspecBuilder
setFlowspecType(FlowspecType value)
Set the property corresponding toFlowspec.getFlowspecType()
to the specified value.
-
-
-
Method Detail
-
getFlowspecType
public FlowspecType getFlowspecType()
Return current value associated with the property corresponding toFlowspec.getFlowspecType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec>> 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
-
setFlowspecType
public FlowspecBuilder setFlowspecType(FlowspecType value)
Set the property corresponding toFlowspec.getFlowspecType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowspecBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec> 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 FlowspecBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Flowspec>> 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
-
-