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