Class BundleFlowModCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.BundleFlowModCaseBuilder
-
@Generated("mdsal-binding-generator") public class BundleFlowModCaseBuilder extends Object
Class that buildsBundleFlowModCase
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:
BundleFlowModCase createBundleFlowModCase(int fooXyzzy, int barBaz) { return new BundleFlowModCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BundleFlowModCase, 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:
BundleFlowModCase
- 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 BundleFlowModCaseBuilder()
Construct an empty builder.BundleFlowModCaseBuilder(BundleFlowModCase base)
Construct a builder initialized with state from specifiedBundleFlowModCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BundleFlowModCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BundleFlowModCase
build()
A newBundleFlowModCase
instance.FlowModCaseData
getFlowModCaseData()
Return current value associated with the property corresponding toBundleFlowModCase.getFlowModCaseData()
.BundleFlowModCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase>> augmentationType)
Remove an augmentation from this builder's product.BundleFlowModCaseBuilder
setFlowModCaseData(FlowModCaseData value)
Set the property corresponding toBundleFlowModCase.getFlowModCaseData()
to the specified value.
-
-
-
Constructor Detail
-
BundleFlowModCaseBuilder
public BundleFlowModCaseBuilder()
Construct an empty builder.
-
BundleFlowModCaseBuilder
public BundleFlowModCaseBuilder(BundleFlowModCase base)
Construct a builder initialized with state from specifiedBundleFlowModCase
.- Parameters:
base
- BundleFlowModCase from which the builder should be initialized
-
-
Method Detail
-
getFlowModCaseData
public FlowModCaseData getFlowModCaseData()
Return current value associated with the property corresponding toBundleFlowModCase.getFlowModCaseData()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase>> 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
-
setFlowModCaseData
public BundleFlowModCaseBuilder setFlowModCaseData(FlowModCaseData value)
Set the property corresponding toBundleFlowModCase.getFlowModCaseData()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BundleFlowModCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase> 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 BundleFlowModCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BundleFlowModCase>> 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 BundleFlowModCase build()
A newBundleFlowModCase
instance.- Returns:
- A new
BundleFlowModCase
instance.
-
-