Class RequestsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.RequestsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Requests>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Requests,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RequestsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Requests>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description RequestsBuilder()
RequestsBuilder(Requests base)
RequestsBuilder(RpObject arg)
RequestsBuilder(VendorInformationObjects arg)
-
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)
Requests
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PathKeyExpansion
getPathKeyExpansion()
Rp
getRp()
SegmentComputation
getSegmentComputation()
List<VendorInformationObject>
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)
RequestsBuilder
setRp(Rp value)
RequestsBuilder
setSegmentComputation(SegmentComputation value)
RequestsBuilder
setVendorInformationObject(List<VendorInformationObject> values)
-
-
-
Constructor Detail
-
RequestsBuilder
public RequestsBuilder()
-
RequestsBuilder
public RequestsBuilder(RpObject arg)
-
RequestsBuilder
public RequestsBuilder(VendorInformationObjects arg)
-
RequestsBuilder
public RequestsBuilder(Requests base)
-
-
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:- RpObject
- VendorInformationObjects
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPathKeyExpansion
public PathKeyExpansion getPathKeyExpansion()
-
getRp
public Rp getRp()
-
getSegmentComputation
public SegmentComputation getSegmentComputation()
-
getVendorInformationObject
public List<VendorInformationObject> getVendorInformationObject()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Requests>> E$$ augmentation(Class<E$$> augmentationType)
-
setPathKeyExpansion
public RequestsBuilder setPathKeyExpansion(PathKeyExpansion value)
-
setRp
public RequestsBuilder setRp(Rp value)
-
setSegmentComputation
public RequestsBuilder setSegmentComputation(SegmentComputation value)
-
setVendorInformationObject
public RequestsBuilder setVendorInformationObject(List<VendorInformationObject> values)
-
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
-
build
public Requests build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Requests>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Requests,IllegalArgumentException>
-
-