Class RequestsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.RequestsBuilder
-
@Generated("mdsal-binding-generator") public class RequestsBuilder extends Object
Class that buildsRequests
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:
Requests createRequests(int fooXyzzy, int barBaz) { return new RequestsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Requests, 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:
Requests
- 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 RequestsBuilder()
Construct an empty builder.RequestsBuilder(Requests base)
Construct a builder initialized with state from specifiedRequests
.RequestsBuilder(RpObject arg)
Construct a new builder initialized from specifiedRpObject
.RequestsBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RequestsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Requests> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Requests
build()
A newRequests
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PathKeyExpansion
getPathKeyExpansion()
Return current value associated with the property corresponding toRequests.getPathKeyExpansion()
.Rp
getRp()
Return current value associated with the property corresponding toRpObject.getRp()
.SegmentComputation
getSegmentComputation()
Return current value associated with the property corresponding toRequests.getSegmentComputation()
.List<VendorInformationObject>
getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.RequestsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>> augmentationType)
Remove an augmentation from this builder's product.RequestsBuilder
setPathKeyExpansion(PathKeyExpansion value)
Set the property corresponding toRequests.getPathKeyExpansion()
to the specified value.RequestsBuilder
setRp(Rp value)
Set the property corresponding toRpObject.getRp()
to the specified value.RequestsBuilder
setSegmentComputation(SegmentComputation value)
Set the property corresponding toRequests.getSegmentComputation()
to the specified value.RequestsBuilder
setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.
-
-
-
Constructor Detail
-
RequestsBuilder
public RequestsBuilder()
Construct an empty builder.
-
RequestsBuilder
public RequestsBuilder(RpObject arg)
Construct a new builder initialized from specifiedRpObject
.- Parameters:
arg
- RpObject from which the builder should be initialized
-
RequestsBuilder
public RequestsBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.- Parameters:
arg
- VendorInformationObjects 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
-
getPathKeyExpansion
public PathKeyExpansion getPathKeyExpansion()
Return current value associated with the property corresponding toRequests.getPathKeyExpansion()
.- Returns:
- current value
-
getRp
public Rp getRp()
Return current value associated with the property corresponding toRpObject.getRp()
.- Returns:
- current value
-
getSegmentComputation
public SegmentComputation getSegmentComputation()
Return current value associated with the property corresponding toRequests.getSegmentComputation()
.- Returns:
- current value
-
getVendorInformationObject
public List<VendorInformationObject> getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>> 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
-
setPathKeyExpansion
public RequestsBuilder setPathKeyExpansion(PathKeyExpansion value)
Set the property corresponding toRequests.getPathKeyExpansion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRp
public RequestsBuilder setRp(Rp value)
Set the property corresponding toRpObject.getRp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSegmentComputation
public RequestsBuilder setSegmentComputation(SegmentComputation value)
Set the property corresponding toRequests.getSegmentComputation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVendorInformationObject
public RequestsBuilder setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public RequestsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Requests> 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 RequestsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>> 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
-
-