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