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
Class that builds
Icmpv4Code
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:
Icmpv4Code createIcmpv4Code(int fooXyzzy, int barBaz) {
return new Icmpv4CodeBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Icmpv4Code, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Icmpv4CodeBuilder
(Icmpv4Code base) Construct a builder initialized with state from specifiedIcmpv4Code
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Icmpv4Code
build()
A newIcmpv4Code
instance.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toIcmpv4Code.getIcmpv4Code()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code>> augmentationType) Remove an augmentation from this builder's product.setIcmpv4Code
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toIcmpv4Code.getIcmpv4Code()
to the specified value.
-
Constructor Details
-
Icmpv4CodeBuilder
public Icmpv4CodeBuilder()Construct an empty builder. -
Icmpv4CodeBuilder
Construct a builder initialized with state from specifiedIcmpv4Code
.- Parameters:
base
- Icmpv4Code from which the builder should be initialized
-
-
Method Details
-
getIcmpv4Code
public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv4Code()Return current value associated with the property corresponding toIcmpv4Code.getIcmpv4Code()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setIcmpv4Code
Set the property corresponding toIcmpv4Code.getIcmpv4Code()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Icmpv4CodeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code> 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 Icmpv4CodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Code>> 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
A newIcmpv4Code
instance.- Returns:
- A new
Icmpv4Code
instance.
-