Class ConfederationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.ConfederationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Confederation>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Confederation,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConfederationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Confederation>
Class that buildsConfederationBuilder
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:
ConfederationBuilder createTarget(int fooXyzzy, int barBaz) { return new ConfederationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConfederationBuilder, 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 oportunities, 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:
ConfederationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConfederationBuilder()
ConfederationBuilder(Confederation base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConfederationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Confederation> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>>
E$$augmentation(Class<E$$> augmentationType)
Confederation
build()
Config
getConfig()
State
getState()
ConfederationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>> augmentationType)
ConfederationBuilder
setConfig(Config value)
ConfederationBuilder
setState(State value)
-
-
-
Constructor Detail
-
ConfederationBuilder
public ConfederationBuilder()
-
ConfederationBuilder
public ConfederationBuilder(Confederation base)
-
-
Method Detail
-
getConfig
public Config getConfig()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public ConfederationBuilder setConfig(Config value)
-
setState
public ConfederationBuilder setState(State value)
-
addAugmentation
public ConfederationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Confederation> augmentationValue)
-
removeAugmentation
public ConfederationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Confederation>> augmentationType)
-
build
public Confederation build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Confederation>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Confederation,IllegalArgumentException>
-
-