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