Class SrcNxNshMdtypeCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.src.choice.grouping.src.choice.SrcNxNshMdtypeCaseBuilder
Class that builds
SrcNxNshMdtypeCase
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:
SrcNxNshMdtypeCase createSrcNxNshMdtypeCase(int fooXyzzy, int barBaz) {
return new SrcNxNshMdtypeCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SrcNxNshMdtypeCase, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedNxmNxNshMdtypeGrouping
.Construct a builder initialized with state from specifiedSrcNxNshMdtypeCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SrcNxNshMdtypeCase
build()
A newSrcNxNshMdtypeCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Empty
Return current value associated with the property corresponding toNxmNxNshMdtypeGrouping.getNxNshMdtype()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase>> augmentationType) Remove an augmentation from this builder's product.setNxNshMdtype
(org.opendaylight.yangtools.yang.common.Empty value) Set the property corresponding toNxmNxNshMdtypeGrouping.getNxNshMdtype()
to the specified value.
-
Constructor Details
-
SrcNxNshMdtypeCaseBuilder
public SrcNxNshMdtypeCaseBuilder()Construct an empty builder. -
SrcNxNshMdtypeCaseBuilder
Construct a new builder initialized from specifiedNxmNxNshMdtypeGrouping
.- Parameters:
arg
- NxmNxNshMdtypeGrouping from which the builder should be initialized
-
SrcNxNshMdtypeCaseBuilder
Construct a builder initialized with state from specifiedSrcNxNshMdtypeCase
.- Parameters:
base
- SrcNxNshMdtypeCase from which the builder should be initialized
-
-
Method Details
-
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
-
getNxNshMdtype
public org.opendaylight.yangtools.yang.common.Empty getNxNshMdtype()Return current value associated with the property corresponding toNxmNxNshMdtypeGrouping.getNxNshMdtype()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase>> 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
-
setNxNshMdtype
Set the property corresponding toNxmNxNshMdtypeGrouping.getNxNshMdtype()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SrcNxNshMdtypeCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase> 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 SrcNxNshMdtypeCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrcNxNshMdtypeCase>> 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
A newSrcNxNshMdtypeCase
instance.- Returns:
- A new
SrcNxNshMdtypeCase
instance.
-