Class BfdLocalConfigsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.tunnel.attributes.BfdLocalConfigsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BfdLocalConfigs>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BfdLocalConfigs,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BfdLocalConfigsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BfdLocalConfigs>
Class that buildsBfdLocalConfigsBuilder
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:
BfdLocalConfigsBuilder createTarget(int fooXyzzy, int barBaz) { return new BfdLocalConfigsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BfdLocalConfigsBuilder, 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:
BfdLocalConfigsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BfdLocalConfigsBuilder()
BfdLocalConfigsBuilder(BfdLocalConfigs base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BfdLocalConfigsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs>>
E$$augmentation(Class<E$$> augmentationType)
BfdLocalConfigs
build()
String
getBfdLocalConfigKey()
String
getBfdLocalConfigValue()
BfdLocalConfigsKey
key()
BfdLocalConfigsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs>> augmentationType)
Remove an augmentation from this builder's product.BfdLocalConfigsBuilder
setBfdLocalConfigKey(String value)
BfdLocalConfigsBuilder
setBfdLocalConfigValue(String value)
BfdLocalConfigsBuilder
withKey(BfdLocalConfigsKey key)
-
-
-
Constructor Detail
-
BfdLocalConfigsBuilder
public BfdLocalConfigsBuilder()
-
BfdLocalConfigsBuilder
public BfdLocalConfigsBuilder(BfdLocalConfigs base)
-
-
Method Detail
-
key
public BfdLocalConfigsKey key()
-
getBfdLocalConfigKey
public String getBfdLocalConfigKey()
-
getBfdLocalConfigValue
public String getBfdLocalConfigValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BfdLocalConfigsBuilder withKey(BfdLocalConfigsKey key)
-
setBfdLocalConfigKey
public BfdLocalConfigsBuilder setBfdLocalConfigKey(String value)
-
setBfdLocalConfigValue
public BfdLocalConfigsBuilder setBfdLocalConfigValue(String value)
-
addAugmentation
public BfdLocalConfigsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs> 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 BfdLocalConfigsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdLocalConfigs>> 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 BfdLocalConfigs build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BfdLocalConfigs>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BfdLocalConfigs,IllegalArgumentException>
-
-