Class NxmOfIcmpTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.icmp.type.grouping.NxmOfIcmpTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmOfIcmpType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmOfIcmpType,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxmOfIcmpTypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmOfIcmpType>
Class that buildsNxmOfIcmpTypeBuilder
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:
NxmOfIcmpTypeBuilder createTarget(int fooXyzzy, int barBaz) { return new NxmOfIcmpTypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmOfIcmpTypeBuilder, 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:
NxmOfIcmpTypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmOfIcmpTypeBuilder()
NxmOfIcmpTypeBuilder(NxmOfIcmpType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxmOfIcmpTypeBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.NxmOfIcmpTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>>
E$$augmentation(Class<E$$> augmentationType)
NxmOfIcmpType
build()
org.opendaylight.yangtools.yang.common.Uint8
getValue()
NxmOfIcmpTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>> augmentationType)
Remove an augmentation from this builder's product.NxmOfIcmpTypeBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.NxmOfIcmpTypeBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NxmOfIcmpTypeBuilder
public NxmOfIcmpTypeBuilder()
-
NxmOfIcmpTypeBuilder
public NxmOfIcmpTypeBuilder(NxmOfIcmpType base)
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public NxmOfIcmpTypeBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public NxmOfIcmpTypeBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxmOfIcmpTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType> 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 NxmOfIcmpTypeBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType> 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 NxmOfIcmpTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIcmpType>> 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 NxmOfIcmpType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmOfIcmpType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmOfIcmpType,IllegalArgumentException>
-
-