Class ConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base._default.route.distance.ConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Config>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Config,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Config>
Class that buildsConfigBuilder
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:
ConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new ConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConfigBuilder, 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:
ConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConfigBuilder()
ConfigBuilder(Config base)
ConfigBuilder(BgpDefaultRouteDistanceConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConfigBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>>
E$$augmentation(Class<E$$> augmentationType)
Config
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getExternalRouteDistance()
org.opendaylight.yangtools.yang.common.Uint8
getInternalRouteDistance()
ConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
ConfigBuilder
setExternalRouteDistance(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setExternalRouteDistance(Uint8)} instead.ConfigBuilder
setExternalRouteDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
ConfigBuilder
setInternalRouteDistance(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInternalRouteDistance(Uint8)} instead.ConfigBuilder
setInternalRouteDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
-
ConfigBuilder
public ConfigBuilder(BgpDefaultRouteDistanceConfig arg)
-
ConfigBuilder
public ConfigBuilder(Config base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.BgpDefaultRouteDistanceConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getExternalRouteDistance
public org.opendaylight.yangtools.yang.common.Uint8 getExternalRouteDistance()
-
getInternalRouteDistance
public org.opendaylight.yangtools.yang.common.Uint8 getInternalRouteDistance()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType)
-
setExternalRouteDistance
public ConfigBuilder setExternalRouteDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setExternalRouteDistance
@Deprecated(forRemoval=true) public ConfigBuilder setExternalRouteDistance(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setExternalRouteDistance(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInternalRouteDistance
public ConfigBuilder setInternalRouteDistance(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setInternalRouteDistance
@Deprecated(forRemoval=true) public ConfigBuilder setInternalRouteDistance(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInternalRouteDistance(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public ConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
-
removeAugmentation
public ConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
-
build
public Config build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Config>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Config,IllegalArgumentException>
-
-