Class ConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.multiprotocol.rev151009.bgp.route.selection.options.route.selection.options.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>
@Generated("mdsal-binding-generator") 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(BgpRouteSelectionOptionsConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentation)
Add an augmentation to this builder's product.<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.Boolean
getAdvertiseInactiveRoutes()
Boolean
getAlwaysCompareMed()
Boolean
getEnableAigp()
Boolean
getExternalCompareRouterId()
Boolean
getIgnoreAsPathLength()
Boolean
getIgnoreNextHopIgpMetric()
Boolean
isAdvertiseInactiveRoutes()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isAlwaysCompareMed()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isEnableAigp()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isExternalCompareRouterId()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isIgnoreAsPathLength()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isIgnoreNextHopIgpMetric()
Deprecated, for removal: This API element is subject to removal in a future version.ConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
Remove an augmentation from this builder's product.ConfigBuilder
setAdvertiseInactiveRoutes(Boolean value)
ConfigBuilder
setAlwaysCompareMed(Boolean value)
ConfigBuilder
setEnableAigp(Boolean value)
ConfigBuilder
setExternalCompareRouterId(Boolean value)
ConfigBuilder
setIgnoreAsPathLength(Boolean value)
ConfigBuilder
setIgnoreNextHopIgpMetric(Boolean value)
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
-
ConfigBuilder
public ConfigBuilder(BgpRouteSelectionOptionsConfig 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.multiprotocol.rev151009.BgpRouteSelectionOptionsConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertiseInactiveRoutes
public Boolean getAdvertiseInactiveRoutes()
-
isAdvertiseInactiveRoutes
@Deprecated(forRemoval=true) public final Boolean isAdvertiseInactiveRoutes()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getAlwaysCompareMed
public Boolean getAlwaysCompareMed()
-
isAlwaysCompareMed
@Deprecated(forRemoval=true) public final Boolean isAlwaysCompareMed()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getEnableAigp
public Boolean getEnableAigp()
-
isEnableAigp
@Deprecated(forRemoval=true) public final Boolean isEnableAigp()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getExternalCompareRouterId
public Boolean getExternalCompareRouterId()
-
isExternalCompareRouterId
@Deprecated(forRemoval=true) public final Boolean isExternalCompareRouterId()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getIgnoreAsPathLength
public Boolean getIgnoreAsPathLength()
-
isIgnoreAsPathLength
@Deprecated(forRemoval=true) public final Boolean isIgnoreAsPathLength()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getIgnoreNextHopIgpMetric
public Boolean getIgnoreNextHopIgpMetric()
-
isIgnoreNextHopIgpMetric
@Deprecated(forRemoval=true) public final Boolean isIgnoreNextHopIgpMetric()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertiseInactiveRoutes
public ConfigBuilder setAdvertiseInactiveRoutes(Boolean value)
-
setAlwaysCompareMed
public ConfigBuilder setAlwaysCompareMed(Boolean value)
-
setEnableAigp
public ConfigBuilder setEnableAigp(Boolean value)
-
setExternalCompareRouterId
public ConfigBuilder setExternalCompareRouterId(Boolean value)
-
setIgnoreAsPathLength
public ConfigBuilder setIgnoreAsPathLength(Boolean value)
-
setIgnoreNextHopIgpMetric
public ConfigBuilder setIgnoreNextHopIgpMetric(Boolean value)
-
addAugmentation
public ConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Config> 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 ConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> 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 Config build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Config>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Config,IllegalArgumentException>
-
-