Class BfdConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebfd.rev190219.BfdConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BfdConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BfdConfig,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BfdConfigBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BfdConfig>
Class that buildsBfdConfigBuilder
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:
BfdConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new BfdConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BfdConfigBuilder, 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:
BfdConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BfdConfigBuilder()
BfdConfigBuilder(BfdConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BfdConfigBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BfdConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BfdConfig
build()
org.opendaylight.yangtools.yang.common.Uint32
getDetectMult()
org.opendaylight.yangtools.yang.common.Uint32
getMinRx()
org.opendaylight.yangtools.yang.common.Uint32
getMinTx()
java.lang.Boolean
isBfdEnabled()
java.lang.Boolean
isMultihop()
BfdConfigBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>> augmentationType)
Remove an augmentation from this builder's product.BfdConfigBuilder
setBfdEnabled(java.lang.Boolean value)
BfdConfigBuilder
setDetectMult(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDetectMult(Uint32)
instead.BfdConfigBuilder
setDetectMult(org.opendaylight.yangtools.yang.common.Uint32 value)
BfdConfigBuilder
setMinRx(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinRx(Uint32)
instead.BfdConfigBuilder
setMinRx(org.opendaylight.yangtools.yang.common.Uint32 value)
BfdConfigBuilder
setMinTx(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinTx(Uint32)
instead.BfdConfigBuilder
setMinTx(org.opendaylight.yangtools.yang.common.Uint32 value)
BfdConfigBuilder
setMultihop(java.lang.Boolean value)
-
-
-
Constructor Detail
-
BfdConfigBuilder
public BfdConfigBuilder()
-
BfdConfigBuilder
public BfdConfigBuilder(BfdConfig base)
-
-
Method Detail
-
getDetectMult
public org.opendaylight.yangtools.yang.common.Uint32 getDetectMult()
-
getMinRx
public org.opendaylight.yangtools.yang.common.Uint32 getMinRx()
-
getMinTx
public org.opendaylight.yangtools.yang.common.Uint32 getMinTx()
-
isBfdEnabled
public java.lang.Boolean isBfdEnabled()
-
isMultihop
public java.lang.Boolean isMultihop()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDetectMult
public BfdConfigBuilder setDetectMult(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDetectMult
@Deprecated(forRemoval=true) public BfdConfigBuilder setDetectMult(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDetectMult(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinRx
public BfdConfigBuilder setMinRx(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMinRx
@Deprecated(forRemoval=true) public BfdConfigBuilder setMinRx(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinRx(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinTx
public BfdConfigBuilder setMinTx(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMinTx
@Deprecated(forRemoval=true) public BfdConfigBuilder setMinTx(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinTx(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBfdEnabled
public BfdConfigBuilder setBfdEnabled(java.lang.Boolean value)
-
setMultihop
public BfdConfigBuilder setMultihop(java.lang.Boolean value)
-
addAugmentation
public BfdConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public BfdConfigBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public BfdConfigBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdConfig>> 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
-
-