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