Class DefaultRouteDistanceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.global.base.DefaultRouteDistanceBuilder
-
@Generated("mdsal-binding-generator") public class DefaultRouteDistanceBuilder extends Object
Class that buildsDefaultRouteDistance
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:
DefaultRouteDistance createDefaultRouteDistance(int fooXyzzy, int barBaz) { return new DefaultRouteDistanceBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DefaultRouteDistance, 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:
DefaultRouteDistance
- 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 DefaultRouteDistanceBuilder()
Construct an empty builder.DefaultRouteDistanceBuilder(DefaultRouteDistance base)
Construct a builder initialized with state from specifiedDefaultRouteDistance
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DefaultRouteDistanceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DefaultRouteDistance
build()
A newDefaultRouteDistance
instance.Config
getConfig()
Return current value associated with the property corresponding toDefaultRouteDistance.getConfig()
.State
getState()
Return current value associated with the property corresponding toDefaultRouteDistance.getState()
.DefaultRouteDistanceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance>> augmentationType)
Remove an augmentation from this builder's product.DefaultRouteDistanceBuilder
setConfig(Config value)
Set the property corresponding toDefaultRouteDistance.getConfig()
to the specified value.DefaultRouteDistanceBuilder
setState(State value)
Set the property corresponding toDefaultRouteDistance.getState()
to the specified value.
-
-
-
Constructor Detail
-
DefaultRouteDistanceBuilder
public DefaultRouteDistanceBuilder()
Construct an empty builder.
-
DefaultRouteDistanceBuilder
public DefaultRouteDistanceBuilder(DefaultRouteDistance base)
Construct a builder initialized with state from specifiedDefaultRouteDistance
.- Parameters:
base
- DefaultRouteDistance from which the builder should be initialized
-
-
Method Detail
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toDefaultRouteDistance.getConfig()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toDefaultRouteDistance.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance>> 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
-
setConfig
public DefaultRouteDistanceBuilder setConfig(Config value)
Set the property corresponding toDefaultRouteDistance.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public DefaultRouteDistanceBuilder setState(State value)
Set the property corresponding toDefaultRouteDistance.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DefaultRouteDistanceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance> 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 DefaultRouteDistanceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DefaultRouteDistance>> 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 @NonNull DefaultRouteDistance build()
A newDefaultRouteDistance
instance.- Returns:
- A new
DefaultRouteDistance
instance.
-
-