Class CopyTtlInCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.CopyTtlInCaseBuilder
-
@Generated("mdsal-binding-generator") public class CopyTtlInCaseBuilder extends Object
Class that buildsCopyTtlInCase
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:
CopyTtlInCase createCopyTtlInCase(int fooXyzzy, int barBaz) { return new CopyTtlInCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CopyTtlInCase, 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:
CopyTtlInCase
- 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 CopyTtlInCaseBuilder()
Construct an empty builder.CopyTtlInCaseBuilder(CopyTtlInCase base)
Construct a builder initialized with state from specifiedCopyTtlInCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CopyTtlInCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull CopyTtlInCase
build()
A newCopyTtlInCase
instance.CopyTtlIn
getCopyTtlIn()
Return current value associated with the property corresponding toCopyTtlInCase.getCopyTtlIn()
.CopyTtlInCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase>> augmentationType)
Remove an augmentation from this builder's product.CopyTtlInCaseBuilder
setCopyTtlIn(CopyTtlIn value)
Set the property corresponding toCopyTtlInCase.getCopyTtlIn()
to the specified value.
-
-
-
Constructor Detail
-
CopyTtlInCaseBuilder
public CopyTtlInCaseBuilder()
Construct an empty builder.
-
CopyTtlInCaseBuilder
public CopyTtlInCaseBuilder(CopyTtlInCase base)
Construct a builder initialized with state from specifiedCopyTtlInCase
.- Parameters:
base
- CopyTtlInCase from which the builder should be initialized
-
-
Method Detail
-
getCopyTtlIn
public CopyTtlIn getCopyTtlIn()
Return current value associated with the property corresponding toCopyTtlInCase.getCopyTtlIn()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase>> 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
-
setCopyTtlIn
public CopyTtlInCaseBuilder setCopyTtlIn(CopyTtlIn value)
Set the property corresponding toCopyTtlInCase.getCopyTtlIn()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CopyTtlInCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase> 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 CopyTtlInCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CopyTtlInCase>> 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 CopyTtlInCase build()
A newCopyTtlInCase
instance.- Returns:
- A new
CopyTtlInCase
instance.
-
-