Class SrcNxTunIpv4SrcCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.src.choice.grouping.src.choice.SrcNxTunIpv4SrcCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SrcNxTunIpv4SrcCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SrcNxTunIpv4SrcCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrcNxTunIpv4SrcCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SrcNxTunIpv4SrcCase>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrcNxTunIpv4SrcCaseBuilder()
SrcNxTunIpv4SrcCaseBuilder(NxmNxTunIpv4SrcGrouping arg)
SrcNxTunIpv4SrcCaseBuilder(SrcNxTunIpv4SrcCase base)
-
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)
SrcNxTunIpv4SrcCase
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Empty
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)
-
-
-
Constructor Detail
-
SrcNxTunIpv4SrcCaseBuilder
public SrcNxTunIpv4SrcCaseBuilder()
-
SrcNxTunIpv4SrcCaseBuilder
public SrcNxTunIpv4SrcCaseBuilder(NxmNxTunIpv4SrcGrouping arg)
-
SrcNxTunIpv4SrcCaseBuilder
public SrcNxTunIpv4SrcCaseBuilder(SrcNxTunIpv4SrcCase base)
-
-
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:- NxmNxTunIpv4SrcGrouping
- 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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxTunIpv4SrcCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setNxTunIpv4Src
public SrcNxTunIpv4SrcCaseBuilder setNxTunIpv4Src(org.opendaylight.yangtools.yang.common.Empty value)
-
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 SrcNxTunIpv4SrcCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SrcNxTunIpv4SrcCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SrcNxTunIpv4SrcCase,IllegalArgumentException>
-
-