Class DstNxNsiCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstNxNsiCaseBuilder
-
@Generated("mdsal-binding-generator") public class DstNxNsiCaseBuilder extends Object
Class that buildsDstNxNsiCase
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:
DstNxNsiCase createDstNxNsiCase(int fooXyzzy, int barBaz) { return new DstNxNsiCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DstNxNsiCase, 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:
DstNxNsiCase
- 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 DstNxNsiCaseBuilder()
Construct an empty builder.DstNxNsiCaseBuilder(DstNxNsiCase base)
Construct a builder initialized with state from specifiedDstNxNsiCase
.DstNxNsiCaseBuilder(NxmNxNsiGrouping arg)
Construct a new builder initialized from specifiedNxmNxNsiGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DstNxNsiCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DstNxNsiCase
build()
A newDstNxNsiCase
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Empty
getNxNsiDst()
Return current value associated with the property corresponding toNxmNxNsiGrouping.getNxNsiDst()
.DstNxNsiCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase>> augmentationType)
Remove an augmentation from this builder's product.DstNxNsiCaseBuilder
setNxNsiDst(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toNxmNxNsiGrouping.getNxNsiDst()
to the specified value.
-
-
-
Constructor Detail
-
DstNxNsiCaseBuilder
public DstNxNsiCaseBuilder()
Construct an empty builder.
-
DstNxNsiCaseBuilder
public DstNxNsiCaseBuilder(NxmNxNsiGrouping arg)
Construct a new builder initialized from specifiedNxmNxNsiGrouping
.- Parameters:
arg
- NxmNxNsiGrouping from which the builder should be initialized
-
DstNxNsiCaseBuilder
public DstNxNsiCaseBuilder(DstNxNsiCase base)
Construct a builder initialized with state from specifiedDstNxNsiCase
.- Parameters:
base
- DstNxNsiCase 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
-
getNxNsiDst
public org.opendaylight.yangtools.yang.common.Empty getNxNsiDst()
Return current value associated with the property corresponding toNxmNxNsiGrouping.getNxNsiDst()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase>> 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
-
setNxNsiDst
public DstNxNsiCaseBuilder setNxNsiDst(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toNxmNxNsiGrouping.getNxNsiDst()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DstNxNsiCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase> 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 DstNxNsiCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNsiCase>> 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 DstNxNsiCase build()
A newDstNxNsiCase
instance.- Returns:
- A new
DstNxNsiCase
instance.
-
-