Class EricOfIcmpv6NdReservedBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.eric.match.rev180730.eric.of.icmpv6.nd.reserved.grouping.EricOfIcmpv6NdReservedBuilder
Class that builds
EricOfIcmpv6NdReserved
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:
EricOfIcmpv6NdReserved createEricOfIcmpv6NdReserved(int fooXyzzy, int barBaz) {
return new EricOfIcmpv6NdReservedBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of EricOfIcmpv6NdReserved, 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 builder initialized with state from specifiedEricOfIcmpv6NdReserved
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull EricOfIcmpv6NdReserved
build()
A newEricOfIcmpv6NdReserved
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toEricOfIcmpv6NdReserved.getIcmpv6NdReserved()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved>> augmentationType) Remove an augmentation from this builder's product.setIcmpv6NdReserved
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toEricOfIcmpv6NdReserved.getIcmpv6NdReserved()
to the specified value.
-
Constructor Details
-
EricOfIcmpv6NdReservedBuilder
public EricOfIcmpv6NdReservedBuilder()Construct an empty builder. -
EricOfIcmpv6NdReservedBuilder
Construct a builder initialized with state from specifiedEricOfIcmpv6NdReserved
.- Parameters:
base
- EricOfIcmpv6NdReserved from which the builder should be initialized
-
-
Method Details
-
getIcmpv6NdReserved
public org.opendaylight.yangtools.yang.common.Uint32 getIcmpv6NdReserved()Return current value associated with the property corresponding toEricOfIcmpv6NdReserved.getIcmpv6NdReserved()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved>> 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
-
setIcmpv6NdReserved
public EricOfIcmpv6NdReservedBuilder setIcmpv6NdReserved(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toEricOfIcmpv6NdReserved.getIcmpv6NdReserved()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EricOfIcmpv6NdReservedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved> 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 EricOfIcmpv6NdReservedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EricOfIcmpv6NdReserved>> 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 newEricOfIcmpv6NdReserved
instance.- Returns:
- A new
EricOfIcmpv6NdReserved
instance.
-