Class EndpointRroPairBuilder
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.EndpointRroPairBuilder
Class that builds
EndpointRroPair
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:
EndpointRroPair createEndpointRroPair(int fooXyzzy, int barBaz) {
return new EndpointRroPairBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of EndpointRroPair, 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 new builder initialized from specifiedEndpointsObject
.Construct a builder initialized with state from specifiedEndpointRroPair
.Construct a new builder initialized from specifiedReoptimizationBandwidthObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull EndpointRroPair
build()
A newEndpointRroPair
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toEndpointsObject.getEndpointsObj()
.Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.getRros()
Return current value associated with the property corresponding toEndpointRroPair.getRros()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair>> augmentationType) Remove an augmentation from this builder's product.setEndpointsObj
(EndpointsObj value) Set the property corresponding toEndpointsObject.getEndpointsObj()
to the specified value.Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.Set the property corresponding toEndpointRroPair.getRros()
to the specified value.
-
Constructor Details
-
EndpointRroPairBuilder
public EndpointRroPairBuilder()Construct an empty builder. -
EndpointRroPairBuilder
Construct a new builder initialized from specifiedEndpointsObject
.- Parameters:
arg
- EndpointsObject from which the builder should be initialized
-
EndpointRroPairBuilder
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.- Parameters:
arg
- ReoptimizationBandwidthObject from which the builder should be initialized
-
EndpointRroPairBuilder
Construct a builder initialized with state from specifiedEndpointRroPair
.- Parameters:
base
- EndpointRroPair 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
-
getEndpointsObj
Return current value associated with the property corresponding toEndpointsObject.getEndpointsObj()
.- Returns:
- current value
-
getReoptimizationBandwidth
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.- Returns:
- current value
-
getRros
Return current value associated with the property corresponding toEndpointRroPair.getRros()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair>> 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
-
setEndpointsObj
Set the property corresponding toEndpointsObject.getEndpointsObj()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReoptimizationBandwidth
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRros
Set the property corresponding toEndpointRroPair.getRros()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public EndpointRroPairBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair> 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 EndpointRroPairBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointRroPair>> 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 newEndpointRroPair
instance.- Returns:
- A new
EndpointRroPair
instance.
-