Class ReoptimizationBandwidthObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.bandwidth.object.bandwidth.object.reoptimization.bandwidth.object._case.ReoptimizationBandwidthObjectBuilder
-
@Generated("mdsal-binding-generator") public class ReoptimizationBandwidthObjectBuilder extends Object
Class that buildsReoptimizationBandwidthObject
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:
ReoptimizationBandwidthObject createReoptimizationBandwidthObject(int fooXyzzy, int barBaz) { return new ReoptimizationBandwidthObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ReoptimizationBandwidthObject, 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:
ReoptimizationBandwidthObject
- 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 ReoptimizationBandwidthObjectBuilder()
Construct an empty builder.ReoptimizationBandwidthObjectBuilder(ReoptimizationBandwidthObject base)
Construct a builder initialized with state from specifiedReoptimizationBandwidthObject
.ReoptimizationBandwidthObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReoptimizationBandwidthObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ReoptimizationBandwidthObject
build()
A newReoptimizationBandwidthObject
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getBandwidth()
.ReoptimizationBandwidthObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject>> augmentationType)
Remove an augmentation from this builder's product.ReoptimizationBandwidthObjectBuilder
setBandwidth(Bandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getBandwidth()
to the specified value.
-
-
-
Constructor Detail
-
ReoptimizationBandwidthObjectBuilder
public ReoptimizationBandwidthObjectBuilder()
Construct an empty builder.
-
ReoptimizationBandwidthObjectBuilder
public ReoptimizationBandwidthObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
ReoptimizationBandwidthObjectBuilder
public ReoptimizationBandwidthObjectBuilder(ReoptimizationBandwidthObject base)
Construct a builder initialized with state from specifiedReoptimizationBandwidthObject
.- Parameters:
base
- ReoptimizationBandwidthObject 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
-
getBandwidth
public Bandwidth getBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getBandwidth()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject>> 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
-
setBandwidth
public ReoptimizationBandwidthObjectBuilder setBandwidth(Bandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ReoptimizationBandwidthObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject> 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 ReoptimizationBandwidthObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidthObject>> 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 ReoptimizationBandwidthObject build()
A newReoptimizationBandwidthObject
instance.- Returns:
- A new
ReoptimizationBandwidthObject
instance.
-
-