Class NshFlagsCaseValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.aug.nx.exp.match.nx.exp.match.entry.value.NshFlagsCaseValueBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NshFlagsCaseValue>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NshFlagsCaseValue,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NshFlagsCaseValueBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NshFlagsCaseValue>
Class that buildsNshFlagsCaseValue
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:
NshFlagsCaseValue createNshFlagsCaseValue(int fooXyzzy, int barBaz) { return new NshFlagsCaseValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NshFlagsCaseValue, 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:
NshFlagsCaseValue
,Builder
-
-
Constructor Summary
Constructors Constructor Description NshFlagsCaseValueBuilder()
NshFlagsCaseValueBuilder(NshFlagsCaseValue base)
NshFlagsCaseValueBuilder(OfjNxmNxMatchNshFlagsGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NshFlagsCaseValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue>>
E$$augmentation(Class<E$$> augmentationType)
NshFlagsCaseValue
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NshFlagsValues
getNshFlagsValues()
NshFlagsCaseValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue>> augmentationType)
Remove an augmentation from this builder's product.NshFlagsCaseValueBuilder
setNshFlagsValues(NshFlagsValues value)
-
-
-
Constructor Detail
-
NshFlagsCaseValueBuilder
public NshFlagsCaseValueBuilder()
-
NshFlagsCaseValueBuilder
public NshFlagsCaseValueBuilder(OfjNxmNxMatchNshFlagsGrouping arg)
-
NshFlagsCaseValueBuilder
public NshFlagsCaseValueBuilder(NshFlagsCaseValue 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:- OfjNxmNxMatchNshFlagsGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNshFlagsValues
public NshFlagsValues getNshFlagsValues()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue>> E$$ augmentation(Class<E$$> augmentationType)
-
setNshFlagsValues
public NshFlagsCaseValueBuilder setNshFlagsValues(NshFlagsValues value)
-
addAugmentation
public NshFlagsCaseValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue> 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 NshFlagsCaseValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsCaseValue>> 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 NshFlagsCaseValue build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NshFlagsCaseValue>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NshFlagsCaseValue,IllegalArgumentException>
-
-