Class LabeledUnicastRoutesCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.bgp.rib.rib.peer.adj.rib.out.tables.routes.LabeledUnicastRoutesCaseBuilder
Class that builds
LabeledUnicastRoutesCase
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:
LabeledUnicastRoutesCase createLabeledUnicastRoutesCase(int fooXyzzy, int barBaz) {
return new LabeledUnicastRoutesCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of LabeledUnicastRoutesCase, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedLabeledUnicastRoutesCase
.Construct a new builder initialized from specifiedLabeledUnicastRoutes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull LabeledUnicastRoutesCase
build()
A newLabeledUnicastRoutesCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLabeledUnicastRoutes.getLabeledUnicastRoutes()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toLabeledUnicastRoutes.getLabeledUnicastRoutes()
to the specified value.
-
Constructor Details
-
LabeledUnicastRoutesCaseBuilder
public LabeledUnicastRoutesCaseBuilder()Construct an empty builder. -
LabeledUnicastRoutesCaseBuilder
Construct a new builder initialized from specifiedLabeledUnicastRoutes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.LabeledUnicastRoutes from which the builder should be initialized
-
LabeledUnicastRoutesCaseBuilder
Construct a builder initialized with state from specifiedLabeledUnicastRoutesCase
.- Parameters:
base
- LabeledUnicastRoutesCase from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLabeledUnicastRoutes
Return current value associated with the property corresponding toLabeledUnicastRoutes.getLabeledUnicastRoutes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase>> 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
-
setLabeledUnicastRoutes
Set the property corresponding toLabeledUnicastRoutes.getLabeledUnicastRoutes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LabeledUnicastRoutesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase> 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 LabeledUnicastRoutesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoutesCase>> 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
A newLabeledUnicastRoutesCase
instance.- Returns:
- A new
LabeledUnicastRoutesCase
instance.
-