Class DstNxNshc3CaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstNxNshc3CaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DstNxNshc3Case>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DstNxNshc3Case,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class DstNxNshc3CaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<DstNxNshc3Case>
Class that buildsDstNxNshc3Case
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:
DstNxNshc3Case createDstNxNshc3Case(int fooXyzzy, int barBaz) { return new DstNxNshc3CaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DstNxNshc3Case, 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:
DstNxNshc3Case
,Builder
-
-
Constructor Summary
Constructors Constructor Description DstNxNshc3CaseBuilder()
DstNxNshc3CaseBuilder(DstNxNshc3Case base)
DstNxNshc3CaseBuilder(NxmNxNshc3Grouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DstNxNshc3CaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case>>
E$$augmentation(Class<E$$> augmentationType)
DstNxNshc3Case
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Empty
getNxNshc3Dst()
DstNxNshc3CaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case>> augmentationType)
Remove an augmentation from this builder's product.DstNxNshc3CaseBuilder
setNxNshc3Dst(org.opendaylight.yangtools.yang.common.Empty value)
-
-
-
Constructor Detail
-
DstNxNshc3CaseBuilder
public DstNxNshc3CaseBuilder()
-
DstNxNshc3CaseBuilder
public DstNxNshc3CaseBuilder(NxmNxNshc3Grouping arg)
-
DstNxNshc3CaseBuilder
public DstNxNshc3CaseBuilder(DstNxNshc3Case 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:- NxmNxNshc3Grouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNxNshc3Dst
public org.opendaylight.yangtools.yang.common.Empty getNxNshc3Dst()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case>> E$$ augmentation(Class<E$$> augmentationType)
-
setNxNshc3Dst
public DstNxNshc3CaseBuilder setNxNshc3Dst(org.opendaylight.yangtools.yang.common.Empty value)
-
addAugmentation
public DstNxNshc3CaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case> 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 DstNxNshc3CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxNshc3Case>> 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 DstNxNshc3Case build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DstNxNshc3Case>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DstNxNshc3Case,IllegalArgumentException>
-
-