Class RrosBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2mp.endpoint.rro.pair.RrosBuilder
Class that builds
Rros
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:
Rros createRros(int fooXyzzy, int barBaz) {
return new RrosBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Rros, 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.RrosBuilder
(Rros base) Construct a builder initialized with state from specifiedRros
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Rros> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Rros>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Rros
build()
A newRros
instance.Return current value associated with the property corresponding toRros.getRouteObject()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Rros>> augmentationType) Remove an augmentation from this builder's product.setRouteObject
(RouteObject value) Set the property corresponding toRros.getRouteObject()
to the specified value.
-
Constructor Details
-
RrosBuilder
public RrosBuilder()Construct an empty builder. -
RrosBuilder
Construct a builder initialized with state from specifiedRros
.- Parameters:
base
- Rros from which the builder should be initialized
-
-
Method Details
-
getRouteObject
Return current value associated with the property corresponding toRros.getRouteObject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Rros>> 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
-
setRouteObject
Set the property corresponding toRros.getRouteObject()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RrosBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Rros> 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 RrosBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Rros>> 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 newRros
instance.- Returns:
- A new
Rros
instance.
-