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