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
-
@Generated("mdsal-binding-generator") public class ConfigBuilder extends Object
Class that buildsConfig
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:
Config
- 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
-
-
Constructor Summary
Constructors Constructor Description ConfigBuilder()
Construct an empty builder.ConfigBuilder(Config base)
Construct a builder initialized with state from specifiedConfig
.ConfigBuilder(BgpRouteSelectionOptionsConfig arg)
Construct a new builder initialized from specifiedBgpRouteSelectionOptionsConfig
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull Config
build()
A newConfig
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAdvertiseInactiveRoutes()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getAdvertiseInactiveRoutes()
.Boolean
getAlwaysCompareMed()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getAlwaysCompareMed()
.Boolean
getEnableAigp()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getEnableAigp()
.Boolean
getExternalCompareRouterId()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getExternalCompareRouterId()
.Boolean
getIgnoreAsPathLength()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreAsPathLength()
.Boolean
getIgnoreNextHopIgpMetric()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreNextHopIgpMetric()
.ConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
Remove an augmentation from this builder's product.ConfigBuilder
setAdvertiseInactiveRoutes(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getAdvertiseInactiveRoutes()
to the specified value.ConfigBuilder
setAlwaysCompareMed(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getAlwaysCompareMed()
to the specified value.ConfigBuilder
setEnableAigp(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getEnableAigp()
to the specified value.ConfigBuilder
setExternalCompareRouterId(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getExternalCompareRouterId()
to the specified value.ConfigBuilder
setIgnoreAsPathLength(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreAsPathLength()
to the specified value.ConfigBuilder
setIgnoreNextHopIgpMetric(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreNextHopIgpMetric()
to the specified value.
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
Construct an empty builder.
-
ConfigBuilder
public ConfigBuilder(BgpRouteSelectionOptionsConfig arg)
Construct a new builder initialized from specifiedBgpRouteSelectionOptionsConfig
.- Parameters:
arg
- BgpRouteSelectionOptionsConfig from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertiseInactiveRoutes
public Boolean getAdvertiseInactiveRoutes()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getAdvertiseInactiveRoutes()
.- Returns:
- current value
-
getAlwaysCompareMed
public Boolean getAlwaysCompareMed()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getAlwaysCompareMed()
.- Returns:
- current value
-
getEnableAigp
public Boolean getEnableAigp()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getEnableAigp()
.- Returns:
- current value
-
getExternalCompareRouterId
public Boolean getExternalCompareRouterId()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getExternalCompareRouterId()
.- Returns:
- current value
-
getIgnoreAsPathLength
public Boolean getIgnoreAsPathLength()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreAsPathLength()
.- Returns:
- current value
-
getIgnoreNextHopIgpMetric
public Boolean getIgnoreNextHopIgpMetric()
Return current value associated with the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreNextHopIgpMetric()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAdvertiseInactiveRoutes
public ConfigBuilder setAdvertiseInactiveRoutes(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getAdvertiseInactiveRoutes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAlwaysCompareMed
public ConfigBuilder setAlwaysCompareMed(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getAlwaysCompareMed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEnableAigp
public ConfigBuilder setEnableAigp(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getEnableAigp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExternalCompareRouterId
public ConfigBuilder setExternalCompareRouterId(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getExternalCompareRouterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnoreAsPathLength
public ConfigBuilder setIgnoreAsPathLength(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreAsPathLength()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnoreNextHopIgpMetric
public ConfigBuilder setIgnoreNextHopIgpMetric(Boolean value)
Set the property corresponding toBgpRouteSelectionOptionsConfig.getIgnoreNextHopIgpMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-