Class LoadBalancingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.load.balancing.object.LoadBalancingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LoadBalancing>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LoadBalancing,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LoadBalancingBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LoadBalancing>
Class that buildsLoadBalancingBuilder
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:
LoadBalancingBuilder createTarget(int fooXyzzy, int barBaz) { return new LoadBalancingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LoadBalancingBuilder, 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 oportunities, 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:
LoadBalancingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LoadBalancingBuilder()
LoadBalancingBuilder(LoadBalancing base)
LoadBalancingBuilder(Object arg)
LoadBalancingBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
LoadBalancing
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
org.opendaylight.yangtools.yang.common.Uint8
getMaxLsp()
Bandwidth
getMinBandwidth()
Boolean
getProcessingRule()
Boolean
isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.LoadBalancingBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing>> augmentationType)
Remove an augmentation from this builder's product.LoadBalancingBuilder
setIgnore(Boolean value)
LoadBalancingBuilder
setMaxLsp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLsp(Uint8)
instead.LoadBalancingBuilder
setMaxLsp(org.opendaylight.yangtools.yang.common.Uint8 value)
LoadBalancingBuilder
setMinBandwidth(Bandwidth value)
LoadBalancingBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
LoadBalancingBuilder
public LoadBalancingBuilder()
-
LoadBalancingBuilder
public LoadBalancingBuilder(Object arg)
-
LoadBalancingBuilder
public LoadBalancingBuilder(ObjectHeader arg)
-
LoadBalancingBuilder
public LoadBalancingBuilder(LoadBalancing 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
-
isIgnore
@Deprecated(forRemoval=true) public final Boolean isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getMaxLsp
public org.opendaylight.yangtools.yang.common.Uint8 getMaxLsp()
-
getMinBandwidth
public Bandwidth getMinBandwidth()
-
getProcessingRule
public Boolean getProcessingRule()
-
isProcessingRule
@Deprecated(forRemoval=true) public final Boolean isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LoadBalancing>> E$$ augmentation(Class<E$$> augmentationType)
-
setIgnore
public LoadBalancingBuilder setIgnore(Boolean value)
-
setMaxLsp
public LoadBalancingBuilder setMaxLsp(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMaxLsp
@Deprecated(forRemoval=true) public LoadBalancingBuilder setMaxLsp(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxLsp(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinBandwidth
public LoadBalancingBuilder setMinBandwidth(Bandwidth value)
-
setProcessingRule
public LoadBalancingBuilder setProcessingRule(Boolean value)
-
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 LoadBalancing build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LoadBalancing>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LoadBalancing,IllegalArgumentException>
-
-