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