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