Class SuccessBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case.SuccessBuilder
-
@Generated("mdsal-binding-generator") public class SuccessBuilder extends Object
Class that buildsSuccess
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:
Success createSuccess(int fooXyzzy, int barBaz) { return new SuccessBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Success, 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:
Success
- 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 SuccessBuilder()
Construct an empty builder.SuccessBuilder(Success base)
Construct a builder initialized with state from specifiedSuccess
.SuccessBuilder(VendorInformationObjects arg)
Construct a new builder initialized from specifiedVendorInformationObjects
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SuccessBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Success> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Success
build()
A newSuccess
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Paths>
getPaths()
Return current value associated with the property corresponding toSuccess.getPaths()
.List<VendorInformationObject>
getVendorInformationObject()
Return current value associated with the property corresponding toVendorInformationObjects.getVendorInformationObject()
.SuccessBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>> augmentationType)
Remove an augmentation from this builder's product.SuccessBuilder
setPaths(List<Paths> values)
Set the property corresponding toSuccess.getPaths()
to the specified value.SuccessBuilder
setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.
-
-
-
Constructor Detail
-
SuccessBuilder
public SuccessBuilder()
Construct an empty builder.
-
SuccessBuilder
public SuccessBuilder(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
-
getPaths
public List<Paths> getPaths()
Return current value associated with the property corresponding toSuccess.getPaths()
.- 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<Success>> 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
-
setPaths
public SuccessBuilder setPaths(List<Paths> values)
Set the property corresponding toSuccess.getPaths()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVendorInformationObject
public SuccessBuilder setVendorInformationObject(List<VendorInformationObject> values)
Set the property corresponding toVendorInformationObjects.getVendorInformationObject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SuccessBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Success> 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 SuccessBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Success>> 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
-
-