Class IcmpTypeValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.of.match.icmp.type.grouping.IcmpTypeValuesBuilder
-
@Generated("mdsal-binding-generator") public class IcmpTypeValuesBuilder extends Object
Class that buildsIcmpTypeValues
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:
IcmpTypeValues createIcmpTypeValues(int fooXyzzy, int barBaz) { return new IcmpTypeValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IcmpTypeValues, 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:
IcmpTypeValues
- 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
-
-
Constructor Summary
Constructors Constructor Description IcmpTypeValuesBuilder()
Construct an empty builder.IcmpTypeValuesBuilder(IcmpTypeValues base)
Construct a builder initialized with state from specifiedIcmpTypeValues
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IcmpTypeValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull IcmpTypeValues
build()
A newIcmpTypeValues
instance.org.opendaylight.yangtools.yang.common.Uint8
getValue()
Return current value associated with the property corresponding toIcmpTypeValues.getValue()
.IcmpTypeValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues>> augmentationType)
Remove an augmentation from this builder's product.IcmpTypeValuesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toIcmpTypeValues.getValue()
to the specified value.
-
-
-
Constructor Detail
-
IcmpTypeValuesBuilder
public IcmpTypeValuesBuilder()
Construct an empty builder.
-
IcmpTypeValuesBuilder
public IcmpTypeValuesBuilder(IcmpTypeValues base)
Construct a builder initialized with state from specifiedIcmpTypeValues
.- Parameters:
base
- IcmpTypeValues from which the builder should be initialized
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
Return current value associated with the property corresponding toIcmpTypeValues.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues>> 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
-
setValue
public IcmpTypeValuesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toIcmpTypeValues.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IcmpTypeValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues> 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 IcmpTypeValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpTypeValues>> 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 @NonNull IcmpTypeValues build()
A newIcmpTypeValues
instance.- Returns:
- A new
IcmpTypeValues
instance.
-
-