Class MonitoringRequestBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.MonitoringRequestBuilder
-
@Generated("mdsal-binding-generator") public class MonitoringRequestBuilder extends Object
Class that buildsMonitoringRequest
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:
MonitoringRequest
- 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 MonitoringRequestBuilder()
Construct an empty builder.MonitoringRequestBuilder(Monitoring arg)
Construct a new builder initialized from specifiedMonitoring
.MonitoringRequestBuilder(MonitoringObject arg)
Construct a new builder initialized from specifiedMonitoringObject
.MonitoringRequestBuilder(PccIdReqObject arg)
Construct a new builder initialized from specifiedPccIdReqObject
.MonitoringRequestBuilder(MonitoringRequest base)
Construct a builder initialized with state from specifiedMonitoringRequest
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MonitoringRequestBuilder
addAugmentation(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.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Monitoring
getMonitoring()
Return current value associated with the property corresponding toMonitoringObject.getMonitoring()
.PccIdReq
getPccIdReq()
Return current value associated with the property corresponding toPccIdReqObject.getPccIdReq()
.List<PceIdList>
getPceIdList()
Return current value associated with the property corresponding toMonitoringRequest.getPceIdList()
.MonitoringRequestBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitoringRequest>> augmentationType)
Remove an augmentation from this builder's product.MonitoringRequestBuilder
setMonitoring(Monitoring value)
Set the property corresponding toMonitoringObject.getMonitoring()
to the specified value.MonitoringRequestBuilder
setPccIdReq(PccIdReq value)
Set the property corresponding toPccIdReqObject.getPccIdReq()
to the specified value.MonitoringRequestBuilder
setPceIdList(List<PceIdList> values)
Set the property corresponding toMonitoringRequest.getPceIdList()
to the specified value.
-
-
-
Constructor Detail
-
MonitoringRequestBuilder
public MonitoringRequestBuilder()
Construct an empty builder.
-
MonitoringRequestBuilder
public MonitoringRequestBuilder(Monitoring arg)
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
public MonitoringRequestBuilder(MonitoringObject arg)
Construct a new builder initialized from specifiedMonitoringObject
.- Parameters:
arg
- MonitoringObject from which the builder should be initialized
-
MonitoringRequestBuilder
public MonitoringRequestBuilder(PccIdReqObject arg)
Construct a new builder initialized from specifiedPccIdReqObject
.- Parameters:
arg
- PccIdReqObject from which the builder should be initialized
-
MonitoringRequestBuilder
public MonitoringRequestBuilder(MonitoringRequest base)
Construct a builder initialized with state from specifiedMonitoringRequest
.- Parameters:
base
- MonitoringRequest from which the builder should be initialized
-
-
Method Detail
-
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
-
getMonitoring
public Monitoring getMonitoring()
Return current value associated with the property corresponding toMonitoringObject.getMonitoring()
.- Returns:
- current value
-
getPccIdReq
public PccIdReq getPccIdReq()
Return current value associated with the property corresponding toPccIdReqObject.getPccIdReq()
.- Returns:
- current value
-
getPceIdList
public List<PceIdList> 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
public MonitoringRequestBuilder setMonitoring(Monitoring value)
Set the property corresponding toMonitoringObject.getMonitoring()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPccIdReq
public MonitoringRequestBuilder setPccIdReq(PccIdReq value)
Set the property corresponding toPccIdReqObject.getPccIdReq()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPceIdList
public MonitoringRequestBuilder setPceIdList(List<PceIdList> values)
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
public @NonNull MonitoringRequest build()
A newMonitoringRequest
instance.- Returns:
- A new
MonitoringRequest
instance.
-
-