Class MonitoringRequestBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.MonitoringRequestBuilder
Class that builds
MonitoringRequest
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:
MonitoringRequest createMonitoringRequest(int fooXyzzy, int barBaz) {
return new MonitoringRequestBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MonitoringRequest, 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 specifiedMonitoring
.Construct a new builder initialized from specifiedMonitoringObject
.Construct a new builder initialized from specifiedPccIdReqObject
.Construct a builder initialized with state from specifiedMonitoringRequest
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MonitoringRequest
build()
A newMonitoringRequest
instance.static @NonNull MonitoringRequest
empty()
Get empty instance of MonitoringRequest.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMonitoringObject.getMonitoring()
.Return current value associated with the property corresponding toPccIdReqObject.getPccIdReq()
.Return current value associated with the property corresponding toMonitoringRequest.getPceIdList()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest>> augmentationType) Remove an augmentation from this builder's product.setMonitoring
(Monitoring value) Set the property corresponding toMonitoringObject.getMonitoring()
to the specified value.setPccIdReq
(PccIdReq value) Set the property corresponding toPccIdReqObject.getPccIdReq()
to the specified value.setPceIdList
(List<PceIdList> values) Set the property corresponding toMonitoringRequest.getPceIdList()
to the specified value.
-
Constructor Details
-
MonitoringRequestBuilder
public MonitoringRequestBuilder()Construct an empty builder. -
MonitoringRequestBuilder
Construct a new builder initialized from specifiedMonitoring
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Monitoring from which the builder should be initialized
-
MonitoringRequestBuilder
Construct a new builder initialized from specifiedMonitoringObject
.- Parameters:
arg
- MonitoringObject from which the builder should be initialized
-
MonitoringRequestBuilder
Construct a new builder initialized from specifiedPccIdReqObject
.- Parameters:
arg
- PccIdReqObject from which the builder should be initialized
-
MonitoringRequestBuilder
Construct a builder initialized with state from specifiedMonitoringRequest
.- Parameters:
base
- MonitoringRequest 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
-
empty
Get empty instance of MonitoringRequest.- Returns:
- An empty
MonitoringRequest
-
getMonitoring
Return current value associated with the property corresponding toMonitoringObject.getMonitoring()
.- Returns:
- current value
-
getPccIdReq
Return current value associated with the property corresponding toPccIdReqObject.getPccIdReq()
.- Returns:
- current value
-
getPceIdList
Return current value associated with the property corresponding toMonitoringRequest.getPceIdList()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest>> 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
-
setMonitoring
Set the property corresponding toMonitoringObject.getMonitoring()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPccIdReq
Set the property corresponding toPccIdReqObject.getPccIdReq()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPceIdList
Set the property corresponding toMonitoringRequest.getPceIdList()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MonitoringRequestBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest> 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 MonitoringRequestBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest>> 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 newMonitoringRequest
instance.- Returns:
- A new
MonitoringRequest
instance.
-