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