Class InterfaceBfdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceBfdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceBfd>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceBfd,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceBfdBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceBfd>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceBfdBuilder()
InterfaceBfdBuilder(InterfaceBfd base)
-
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)
InterfaceBfd
build()
String
getBfdKey()
String
getBfdValue()
InterfaceBfdKey
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)
InterfaceBfdBuilder
setBfdValue(String value)
InterfaceBfdBuilder
withKey(InterfaceBfdKey key)
-
-
-
Constructor Detail
-
InterfaceBfdBuilder
public InterfaceBfdBuilder()
-
InterfaceBfdBuilder
public InterfaceBfdBuilder(InterfaceBfd base)
-
-
Method Detail
-
key
public InterfaceBfdKey key()
-
getBfdKey
public String getBfdKey()
-
getBfdValue
public String getBfdValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceBfd>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public InterfaceBfdBuilder withKey(InterfaceBfdKey key)
-
setBfdKey
public InterfaceBfdBuilder setBfdKey(String value)
-
setBfdValue
public InterfaceBfdBuilder setBfdValue(String value)
-
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 InterfaceBfd build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceBfd>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceBfd,IllegalArgumentException>
-
-