Class Icmpv6NdOptionsTypeCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.Icmpv6NdOptionsTypeCaseBuilder
-
@Generated("mdsal-binding-generator") public class Icmpv6NdOptionsTypeCaseBuilder extends Object
Class that buildsIcmpv6NdOptionsTypeCase
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:
Icmpv6NdOptionsTypeCase createIcmpv6NdOptionsTypeCase(int fooXyzzy, int barBaz) { return new Icmpv6NdOptionsTypeCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Icmpv6NdOptionsTypeCase, 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:
Icmpv6NdOptionsTypeCase
- 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 Icmpv6NdOptionsTypeCaseBuilder()
Construct an empty builder.Icmpv6NdOptionsTypeCaseBuilder(Icmpv6NdOptionsTypeCase base)
Construct a builder initialized with state from specifiedIcmpv6NdOptionsTypeCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Icmpv6NdOptionsTypeCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Icmpv6NdOptionsTypeCase
build()
A newIcmpv6NdOptionsTypeCase
instance.Icmpv6NdOptionsType
getIcmpv6NdOptionsType()
Return current value associated with the property corresponding toIcmpv6NdOptionsTypeCase.getIcmpv6NdOptionsType()
.Icmpv6NdOptionsTypeCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase>> augmentationType)
Remove an augmentation from this builder's product.Icmpv6NdOptionsTypeCaseBuilder
setIcmpv6NdOptionsType(Icmpv6NdOptionsType value)
Set the property corresponding toIcmpv6NdOptionsTypeCase.getIcmpv6NdOptionsType()
to the specified value.
-
-
-
Constructor Detail
-
Icmpv6NdOptionsTypeCaseBuilder
public Icmpv6NdOptionsTypeCaseBuilder()
Construct an empty builder.
-
Icmpv6NdOptionsTypeCaseBuilder
public Icmpv6NdOptionsTypeCaseBuilder(Icmpv6NdOptionsTypeCase base)
Construct a builder initialized with state from specifiedIcmpv6NdOptionsTypeCase
.- Parameters:
base
- Icmpv6NdOptionsTypeCase from which the builder should be initialized
-
-
Method Detail
-
getIcmpv6NdOptionsType
public Icmpv6NdOptionsType getIcmpv6NdOptionsType()
Return current value associated with the property corresponding toIcmpv6NdOptionsTypeCase.getIcmpv6NdOptionsType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase>> 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
-
setIcmpv6NdOptionsType
public Icmpv6NdOptionsTypeCaseBuilder setIcmpv6NdOptionsType(Icmpv6NdOptionsType value)
Set the property corresponding toIcmpv6NdOptionsTypeCase.getIcmpv6NdOptionsType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Icmpv6NdOptionsTypeCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase> 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 Icmpv6NdOptionsTypeCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCase>> 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 Icmpv6NdOptionsTypeCase build()
A newIcmpv6NdOptionsTypeCase
instance.- Returns:
- A new
Icmpv6NdOptionsTypeCase
instance.
-
-