Class Icmpv6NdOptionsTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.icmpv6.nd.options.type._case.Icmpv6NdOptionsTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv6NdOptionsType,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Icmpv6NdOptionsTypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsType>
Class that buildsIcmpv6NdOptionsType
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:
Icmpv6NdOptionsType createIcmpv6NdOptionsType(int fooXyzzy, int barBaz) { return new Icmpv6NdOptionsTypeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Icmpv6NdOptionsType, 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:
Icmpv6NdOptionsType
,Builder
-
-
Constructor Summary
Constructors Constructor Description Icmpv6NdOptionsTypeBuilder()
Icmpv6NdOptionsTypeBuilder(Icmpv6NdOptionsType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Icmpv6NdOptionsTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType>>
E$$augmentation(Class<E$$> augmentationType)
Icmpv6NdOptionsType
build()
org.opendaylight.yangtools.yang.common.Uint8
getIcmpv6NdOptionsType()
Icmpv6NdOptionsTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType>> augmentationType)
Remove an augmentation from this builder's product.Icmpv6NdOptionsTypeBuilder
setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
Icmpv6NdOptionsTypeBuilder
public Icmpv6NdOptionsTypeBuilder()
-
Icmpv6NdOptionsTypeBuilder
public Icmpv6NdOptionsTypeBuilder(Icmpv6NdOptionsType base)
-
-
Method Detail
-
getIcmpv6NdOptionsType
public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv6NdOptionsType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType>> E$$ augmentation(Class<E$$> augmentationType)
-
setIcmpv6NdOptionsType
public Icmpv6NdOptionsTypeBuilder setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public Icmpv6NdOptionsTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType> 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 Icmpv6NdOptionsTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsType>> 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 Icmpv6NdOptionsType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv6NdOptionsType,IllegalArgumentException>
-
-