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