Class ConfigBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Config,ConfigBuilder>
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.graceful.restart.graceful.restart.ConfigBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class ConfigBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<Config,ConfigBuilder>
Class that builds
Config 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:
Config createConfig(int fooXyzzy, int barBaz) {
return new ConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Config, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.ConfigBuilder(Config base) Construct a builder initialized with state from specifiedConfig.Construct a new builder initialized from specifiedBgpNeighborGracefulRestartConfig. -
Method Summary
Modifier and TypeMethodDescription@NonNull Configbuild()Returns A newConfiginstance.static @NonNull Configempty()Returns an emptyConfig.voidfieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseorg.opendaylight.yangtools.yang.common.Uint16Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseorg.opendaylight.yangtools.yang.common.Decimal64Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasesetEnabled(Boolean value) Set the property corresponding toBgpNeighborGracefulRestartConfig.getEnabled()to the specified value.setHelperOnly(Boolean value) Set the property corresponding toBgpNeighborGracefulRestartConfig.getHelperOnly()to the specified value.setRestartTime(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toBgpNeighborGracefulRestartConfig.getRestartTime()to the specified value.setStaleRoutesTime(org.opendaylight.yangtools.yang.common.Decimal64 value) Set the property corresponding toBgpNeighborGracefulRestartConfig.getStaleRoutesTime()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
ConfigBuilder
public ConfigBuilder()Construct an empty builder. -
ConfigBuilder
Construct a new builder initialized from specifiedBgpNeighborGracefulRestartConfig.- Parameters:
arg- BgpNeighborGracefulRestartConfig from which the builder should be initialized
-
ConfigBuilder
Construct a builder initialized with state from specifiedConfig.- Parameters:
base- Config from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg- grouping object- Throws:
IllegalArgumentException- if given argument is none of valid types or has property with incompatible value
-
empty
Returns an emptyConfig.- Returns:
- an empty
Config
-
getEnabled
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGracefulRestartConfig.getEnabled().- Returns:
- current value
-
getHelperOnly
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGracefulRestartConfig.getHelperOnly().- Returns:
- current value
-
getRestartTime
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGracefulRestartConfig.getRestartTime().- Returns:
- current value
-
getStaleRoutesTime
@Deprecated(forRemoval=true) public org.opendaylight.yangtools.yang.common.Decimal64 getStaleRoutesTime()Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGracefulRestartConfig.getStaleRoutesTime().- Returns:
- current value
-
setEnabled
Set the property corresponding toBgpNeighborGracefulRestartConfig.getEnabled()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setHelperOnly
Set the property corresponding toBgpNeighborGracefulRestartConfig.getHelperOnly()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setRestartTime
Set the property corresponding toBgpNeighborGracefulRestartConfig.getRestartTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setStaleRoutesTime
Set the property corresponding toBgpNeighborGracefulRestartConfig.getStaleRoutesTime()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newConfiginstance.- Returns:
- A new
Configinstance
-