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