Class Icmpv6NdOptionsTypeValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.eric.match.rev180730.icmpv6.nd.options.type.grouping.Icmpv6NdOptionsTypeValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsTypeValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv6NdOptionsTypeValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Icmpv6NdOptionsTypeValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsTypeValues>
Class that buildsIcmpv6NdOptionsTypeValuesBuilder
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:
Icmpv6NdOptionsTypeValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new Icmpv6NdOptionsTypeValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Icmpv6NdOptionsTypeValuesBuilder, 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 oportunities, 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:
Icmpv6NdOptionsTypeValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Icmpv6NdOptionsTypeValuesBuilder()
Icmpv6NdOptionsTypeValuesBuilder(Icmpv6NdOptionsTypeValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Icmpv6NdOptionsTypeValuesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Icmpv6NdOptionsTypeValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>>
E$$augmentation(Class<E$$> augmentationType)
Icmpv6NdOptionsTypeValues
build()
org.opendaylight.yangtools.yang.common.Uint8
getIcmpv6NdOptionsType()
Icmpv6NdOptionsTypeValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>> augmentationType)
Remove an augmentation from this builder's product.Icmpv6NdOptionsTypeValuesBuilder
setIcmpv6NdOptionsType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv6NdOptionsType(Uint8)
instead.Icmpv6NdOptionsTypeValuesBuilder
setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
Icmpv6NdOptionsTypeValuesBuilder
public Icmpv6NdOptionsTypeValuesBuilder()
-
Icmpv6NdOptionsTypeValuesBuilder
public Icmpv6NdOptionsTypeValuesBuilder(Icmpv6NdOptionsTypeValues base)
-
-
Method Detail
-
getIcmpv6NdOptionsType
public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv6NdOptionsType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>> E$$ augmentation(Class<E$$> augmentationType)
-
setIcmpv6NdOptionsType
public Icmpv6NdOptionsTypeValuesBuilder setIcmpv6NdOptionsType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIcmpv6NdOptionsType
@Deprecated(forRemoval=true) public Icmpv6NdOptionsTypeValuesBuilder setIcmpv6NdOptionsType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv6NdOptionsType(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public Icmpv6NdOptionsTypeValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public Icmpv6NdOptionsTypeValuesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public Icmpv6NdOptionsTypeValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv6NdOptionsTypeValues>> 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 Icmpv6NdOptionsTypeValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Icmpv6NdOptionsTypeValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv6NdOptionsTypeValues,IllegalArgumentException>
-
-