Class ReoptimizationBandwidthBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.reoptimization.bandwidth.object.ReoptimizationBandwidthBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ReoptimizationBandwidth>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ReoptimizationBandwidth,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ReoptimizationBandwidthBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ReoptimizationBandwidth>
Class that buildsReoptimizationBandwidth
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:
ReoptimizationBandwidth createReoptimizationBandwidth(int fooXyzzy, int barBaz) { return new ReoptimizationBandwidthBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ReoptimizationBandwidth, 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:
ReoptimizationBandwidth
,Builder
-
-
Constructor Summary
Constructors Constructor Description ReoptimizationBandwidthBuilder()
ReoptimizationBandwidthBuilder(Bandwidth arg)
ReoptimizationBandwidthBuilder(Object arg)
ReoptimizationBandwidthBuilder(ObjectHeader arg)
ReoptimizationBandwidthBuilder(ReoptimizationBandwidth base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReoptimizationBandwidthBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth>>
E$$augmentation(Class<E$$> augmentationType)
ReoptimizationBandwidth
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
Boolean
getIgnore()
Boolean
getProcessingRule()
ReoptimizationBandwidthBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth>> augmentationType)
Remove an augmentation from this builder's product.ReoptimizationBandwidthBuilder
setBandwidth(Bandwidth value)
ReoptimizationBandwidthBuilder
setIgnore(Boolean value)
ReoptimizationBandwidthBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
ReoptimizationBandwidthBuilder
public ReoptimizationBandwidthBuilder()
-
ReoptimizationBandwidthBuilder
public ReoptimizationBandwidthBuilder(Object arg)
-
ReoptimizationBandwidthBuilder
public ReoptimizationBandwidthBuilder(ObjectHeader arg)
-
ReoptimizationBandwidthBuilder
public ReoptimizationBandwidthBuilder(Bandwidth arg)
-
ReoptimizationBandwidthBuilder
public ReoptimizationBandwidthBuilder(ReoptimizationBandwidth 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:- ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Bandwidth
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBandwidth
public Bandwidth getBandwidth()
-
getIgnore
public Boolean getIgnore()
-
getProcessingRule
public Boolean getProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandwidth
public ReoptimizationBandwidthBuilder setBandwidth(Bandwidth value)
-
setIgnore
public ReoptimizationBandwidthBuilder setIgnore(Boolean value)
-
setProcessingRule
public ReoptimizationBandwidthBuilder setProcessingRule(Boolean value)
-
addAugmentation
public ReoptimizationBandwidthBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth> 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 ReoptimizationBandwidthBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ReoptimizationBandwidth>> 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 ReoptimizationBandwidth build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ReoptimizationBandwidth>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ReoptimizationBandwidth,IllegalArgumentException>
-
-