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