Class EbgpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.use.multiple.paths.use.multiple.paths.EbgpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ebgp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ebgp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EbgpBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ebgp>
Class that buildsEbgp
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:
Ebgp createEbgp(int fooXyzzy, int barBaz) { return new EbgpBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ebgp, 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:
Ebgp
,Builder
-
-
Constructor Summary
Constructors Constructor Description EbgpBuilder()
EbgpBuilder(Ebgp base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EbgpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp>>
E$$augmentation(Class<E$$> augmentationType)
Ebgp
build()
Config
getConfig()
State
getState()
EbgpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp>> augmentationType)
Remove an augmentation from this builder's product.EbgpBuilder
setConfig(Config value)
EbgpBuilder
setState(State value)
-
-
-
Constructor Detail
-
EbgpBuilder
public EbgpBuilder()
-
EbgpBuilder
public EbgpBuilder(Ebgp base)
-
-
Method Detail
-
getConfig
public Config getConfig()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public EbgpBuilder setConfig(Config value)
-
setState
public EbgpBuilder setState(State value)
-
addAugmentation
public EbgpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp> 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 EbgpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ebgp>> 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 Ebgp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ebgp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ebgp,IllegalArgumentException>
-
-