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