Class BandwidthBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bandwidth.object.BandwidthBuilder
-
@Generated("mdsal-binding-generator") public class BandwidthBuilder extends Object
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
- 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 BandwidthBuilder()
Construct an empty builder.BandwidthBuilder(Bandwidth arg)
Construct a new builder initialized from specifiedBandwidth
.BandwidthBuilder(Bandwidth base)
Construct a builder initialized with state from specifiedBandwidth
.BandwidthBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.BandwidthBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Bandwidth
build()
A newBandwidth
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 toBandwidth.getBandwidth()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.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)
Set the property corresponding toBandwidth.getBandwidth()
to the specified value.BandwidthBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.BandwidthBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
-
-
Constructor Detail
-
BandwidthBuilder
public BandwidthBuilder()
Construct an empty builder.
-
BandwidthBuilder
public BandwidthBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
BandwidthBuilder
public BandwidthBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
BandwidthBuilder
public BandwidthBuilder(Bandwidth arg)
Construct a new builder initialized from specifiedBandwidth
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Bandwidth 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 toBandwidth.getBandwidth()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bandwidth>> 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 BandwidthBuilder setBandwidth(Bandwidth value)
Set the property corresponding toBandwidth.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public BandwidthBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public BandwidthBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-