Class DstNxRegCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.dst.choice.grouping.dst.choice.DstNxRegCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DstNxRegCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DstNxRegCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DstNxRegCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<DstNxRegCase>
Class that buildsDstNxRegCaseBuilder
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:
DstNxRegCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new DstNxRegCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DstNxRegCaseBuilder, 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 oportunities, 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:
DstNxRegCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DstNxRegCaseBuilder()
DstNxRegCaseBuilder(DstNxRegCase base)
DstNxRegCaseBuilder(NxmNxRegGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DstNxRegCaseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DstNxRegCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>>
E$$augmentation(Class<E$$> augmentationType)
DstNxRegCase
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends NxmNxReg>
getNxReg()
DstNxRegCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>> augmentationType)
Remove an augmentation from this builder's product.DstNxRegCaseBuilder
setNxReg(Class<? extends NxmNxReg> value)
-
-
-
Constructor Detail
-
DstNxRegCaseBuilder
public DstNxRegCaseBuilder()
-
DstNxRegCaseBuilder
public DstNxRegCaseBuilder(NxmNxRegGrouping arg)
-
DstNxRegCaseBuilder
public DstNxRegCaseBuilder(DstNxRegCase 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.NxmNxRegGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setNxReg
public DstNxRegCaseBuilder setNxReg(Class<? extends NxmNxReg> value)
-
addAugmentation
public DstNxRegCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public DstNxRegCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public DstNxRegCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DstNxRegCase>> 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 DstNxRegCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DstNxRegCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DstNxRegCase,IllegalArgumentException>
-
-