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