Class LoadBalancingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.load.balancing.object.LoadBalancingBuilder
-
@Generated("mdsal-binding-generator") public class LoadBalancingBuilder extends Object
Class that buildsLoadBalancing
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:
LoadBalancing createLoadBalancing(int fooXyzzy, int barBaz) { return new LoadBalancingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LoadBalancing, 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:
LoadBalancing
- 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 LoadBalancingBuilder()
Construct an empty builder.LoadBalancingBuilder(LoadBalancing base)
Construct a builder initialized with state from specifiedLoadBalancing
.LoadBalancingBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.LoadBalancingBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoadBalancingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LoadBalancing
build()
A newLoadBalancing
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.org.opendaylight.yangtools.yang.common.Uint8
getMaxLsp()
Return current value associated with the property corresponding toLoadBalancing.getMaxLsp()
.Bandwidth
getMinBandwidth()
Return current value associated with the property corresponding toLoadBalancing.getMinBandwidth()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.LoadBalancingBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing>> augmentationType)
Remove an augmentation from this builder's product.LoadBalancingBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.LoadBalancingBuilder
setMaxLsp(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLoadBalancing.getMaxLsp()
to the specified value.LoadBalancingBuilder
setMinBandwidth(Bandwidth value)
Set the property corresponding toLoadBalancing.getMinBandwidth()
to the specified value.LoadBalancingBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
-
-
Constructor Detail
-
LoadBalancingBuilder
public LoadBalancingBuilder()
Construct an empty builder.
-
LoadBalancingBuilder
public LoadBalancingBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
LoadBalancingBuilder
public LoadBalancingBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
LoadBalancingBuilder
public LoadBalancingBuilder(LoadBalancing base)
Construct a builder initialized with state from specifiedLoadBalancing
.- Parameters:
base
- LoadBalancing 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
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getMaxLsp
public org.opendaylight.yangtools.yang.common.Uint8 getMaxLsp()
Return current value associated with the property corresponding toLoadBalancing.getMaxLsp()
.- Returns:
- current value
-
getMinBandwidth
public Bandwidth getMinBandwidth()
Return current value associated with the property corresponding toLoadBalancing.getMinBandwidth()
.- 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<LoadBalancing>> 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
-
setIgnore
public LoadBalancingBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxLsp
public LoadBalancingBuilder setMaxLsp(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toLoadBalancing.getMaxLsp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMinBandwidth
public LoadBalancingBuilder setMinBandwidth(Bandwidth value)
Set the property corresponding toLoadBalancing.getMinBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public LoadBalancingBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LoadBalancingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing> 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 LoadBalancingBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing>> 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 LoadBalancing build()
A newLoadBalancing
instance.- Returns:
- A new
LoadBalancing
instance.
-
-