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