Class BfdRemoteConfigsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.tunnel.attributes.BfdRemoteConfigsBuilder
-
@Generated("mdsal-binding-generator") public class BfdRemoteConfigsBuilder extends Object
Class that buildsBfdRemoteConfigs
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:
BfdRemoteConfigs createBfdRemoteConfigs(int fooXyzzy, int barBaz) { return new BfdRemoteConfigsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BfdRemoteConfigs, 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:
BfdRemoteConfigs
- 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 BfdRemoteConfigsBuilder()
Construct an empty builder.BfdRemoteConfigsBuilder(BfdRemoteConfigs base)
Construct a builder initialized with state from specifiedBfdRemoteConfigs
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BfdRemoteConfigsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BfdRemoteConfigs
build()
A newBfdRemoteConfigs
instance.String
getBfdRemoteConfigKey()
Return current value associated with the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigKey()
.String
getBfdRemoteConfigValue()
Return current value associated with the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigValue()
.BfdRemoteConfigsKey
key()
Return current value associated with the property corresponding toBfdRemoteConfigs.key()
.BfdRemoteConfigsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs>> augmentationType)
Remove an augmentation from this builder's product.BfdRemoteConfigsBuilder
setBfdRemoteConfigKey(String value)
Set the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigKey()
to the specified value.BfdRemoteConfigsBuilder
setBfdRemoteConfigValue(String value)
Set the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigValue()
to the specified value.BfdRemoteConfigsBuilder
withKey(BfdRemoteConfigsKey key)
-
-
-
Constructor Detail
-
BfdRemoteConfigsBuilder
public BfdRemoteConfigsBuilder()
Construct an empty builder.
-
BfdRemoteConfigsBuilder
public BfdRemoteConfigsBuilder(BfdRemoteConfigs base)
Construct a builder initialized with state from specifiedBfdRemoteConfigs
.- Parameters:
base
- BfdRemoteConfigs from which the builder should be initialized
-
-
Method Detail
-
key
public BfdRemoteConfigsKey key()
Return current value associated with the property corresponding toBfdRemoteConfigs.key()
.- Returns:
- current value
-
getBfdRemoteConfigKey
public String getBfdRemoteConfigKey()
Return current value associated with the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigKey()
.- Returns:
- current value
-
getBfdRemoteConfigValue
public String getBfdRemoteConfigValue()
Return current value associated with the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs>> 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
-
withKey
public BfdRemoteConfigsBuilder withKey(BfdRemoteConfigsKey key)
-
setBfdRemoteConfigKey
public BfdRemoteConfigsBuilder setBfdRemoteConfigKey(String value)
Set the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBfdRemoteConfigValue
public BfdRemoteConfigsBuilder setBfdRemoteConfigValue(String value)
Set the property corresponding toBfdRemoteConfigs.getBfdRemoteConfigValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BfdRemoteConfigsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs> 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 BfdRemoteConfigsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BfdRemoteConfigs>> 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 BfdRemoteConfigs build()
A newBfdRemoteConfigs
instance.- Returns:
- A new
BfdRemoteConfigs
instance.
-
-