Class LanAutoGeneratedCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.LanAutoGeneratedCaseBuilder
-
@Generated("mdsal-binding-generator") public class LanAutoGeneratedCaseBuilder extends Object
Class that buildsLanAutoGeneratedCase
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:
LanAutoGeneratedCase createLanAutoGeneratedCase(int fooXyzzy, int barBaz) { return new LanAutoGeneratedCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LanAutoGeneratedCase, 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:
LanAutoGeneratedCase
- 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 LanAutoGeneratedCaseBuilder()
Construct an empty builder.LanAutoGeneratedCaseBuilder(LanAutoGeneratedCase base)
Construct a builder initialized with state from specifiedLanAutoGeneratedCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LanAutoGeneratedCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LanAutoGeneratedCase
build()
A newLanAutoGeneratedCase
instance.LanAutoGenerated
getLanAutoGenerated()
Return current value associated with the property corresponding toLanAutoGeneratedCase.getLanAutoGenerated()
.LanAutoGeneratedCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase>> augmentationType)
Remove an augmentation from this builder's product.LanAutoGeneratedCaseBuilder
setLanAutoGenerated(LanAutoGenerated value)
Set the property corresponding toLanAutoGeneratedCase.getLanAutoGenerated()
to the specified value.
-
-
-
Constructor Detail
-
LanAutoGeneratedCaseBuilder
public LanAutoGeneratedCaseBuilder()
Construct an empty builder.
-
LanAutoGeneratedCaseBuilder
public LanAutoGeneratedCaseBuilder(LanAutoGeneratedCase base)
Construct a builder initialized with state from specifiedLanAutoGeneratedCase
.- Parameters:
base
- LanAutoGeneratedCase from which the builder should be initialized
-
-
Method Detail
-
getLanAutoGenerated
public LanAutoGenerated getLanAutoGenerated()
Return current value associated with the property corresponding toLanAutoGeneratedCase.getLanAutoGenerated()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase>> 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
-
setLanAutoGenerated
public LanAutoGeneratedCaseBuilder setLanAutoGenerated(LanAutoGenerated value)
Set the property corresponding toLanAutoGeneratedCase.getLanAutoGenerated()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LanAutoGeneratedCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase> 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 LanAutoGeneratedCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LanAutoGeneratedCase>> 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 LanAutoGeneratedCase build()
A newLanAutoGeneratedCase
instance.- Returns:
- A new
LanAutoGeneratedCase
instance.
-
-