Class Icmpv6NdOptionsTypeCaseValueBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.eric.match.rev180730.ofj.aug.eric.match.options.Icmpv6NdOptionsTypeCaseValueBuilder
@Generated("mdsal-binding-generator")
public class Icmpv6NdOptionsTypeCaseValueBuilder
extends Object
Class that builds
Icmpv6NdOptionsTypeCaseValue
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:
Icmpv6NdOptionsTypeCaseValue createIcmpv6NdOptionsTypeCaseValue(int fooXyzzy, int barBaz) {
return new Icmpv6NdOptionsTypeCaseValueBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Icmpv6NdOptionsTypeCaseValue, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedIcmpv6NdOptionsTypeGrouping
.Construct a builder initialized with state from specifiedIcmpv6NdOptionsTypeCaseValue
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Icmpv6NdOptionsTypeCaseValue
build()
A newIcmpv6NdOptionsTypeCaseValue
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toIcmpv6NdOptionsTypeGrouping.getIcmpv6NdOptionsTypeValues()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIcmpv6NdOptionsTypeGrouping.getIcmpv6NdOptionsTypeValues()
to the specified value.
-
Constructor Details
-
Icmpv6NdOptionsTypeCaseValueBuilder
public Icmpv6NdOptionsTypeCaseValueBuilder()Construct an empty builder. -
Icmpv6NdOptionsTypeCaseValueBuilder
Construct a new builder initialized from specifiedIcmpv6NdOptionsTypeGrouping
.- Parameters:
arg
- Icmpv6NdOptionsTypeGrouping from which the builder should be initialized
-
Icmpv6NdOptionsTypeCaseValueBuilder
Construct a builder initialized with state from specifiedIcmpv6NdOptionsTypeCaseValue
.- Parameters:
base
- Icmpv6NdOptionsTypeCaseValue 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
-
getIcmpv6NdOptionsTypeValues
Return current value associated with the property corresponding toIcmpv6NdOptionsTypeGrouping.getIcmpv6NdOptionsTypeValues()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue>> 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
-
setIcmpv6NdOptionsTypeValues
public Icmpv6NdOptionsTypeCaseValueBuilder setIcmpv6NdOptionsTypeValues(Icmpv6NdOptionsTypeValues value) Set the property corresponding toIcmpv6NdOptionsTypeGrouping.getIcmpv6NdOptionsTypeValues()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Icmpv6NdOptionsTypeCaseValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue> 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 Icmpv6NdOptionsTypeCaseValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeCaseValue>> 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 newIcmpv6NdOptionsTypeCaseValue
instance.- Returns:
- A new
Icmpv6NdOptionsTypeCaseValue
instance.
-