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