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