Class GlobalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.top.bgp.GlobalBuilder
-
@Generated("mdsal-binding-generator") public class GlobalBuilder extends Object
Class that buildsGlobal
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:
Global createGlobal(int fooXyzzy, int barBaz) { return new GlobalBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Global, 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:
Global
- 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 GlobalBuilder()
Construct an empty builder.GlobalBuilder(BgpRouteSelectionOptions arg)
Construct a new builder initialized from specifiedBgpRouteSelectionOptions
.GlobalBuilder(BgpUseMultiplePaths arg)
Construct a new builder initialized from specifiedBgpUseMultiplePaths
.GlobalBuilder(Global base)
Construct a builder initialized with state from specifiedGlobal
.GlobalBuilder(BgpGlobalBase arg)
Construct a new builder initialized from specifiedBgpGlobalBase
.GlobalBuilder(BgpGracefulRestart arg)
Construct a new builder initialized from specifiedBgpGracefulRestart
.GlobalBuilder(ApplyPolicyGroup arg)
Construct a new builder initialized from specifiedApplyPolicyGroup
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GlobalBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Global> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Global>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Global
build()
A newGlobal
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AfiSafis
getAfiSafis()
Return current value associated with the property corresponding toBgpGlobalBase.getAfiSafis()
.ApplyPolicy
getApplyPolicy()
Return current value associated with the property corresponding toApplyPolicyGroup.getApplyPolicy()
.Confederation
getConfederation()
Return current value associated with the property corresponding toBgpGlobalBase.getConfederation()
.Config
getConfig()
Return current value associated with the property corresponding toBgpGlobalBase.getConfig()
.DefaultRouteDistance
getDefaultRouteDistance()
Return current value associated with the property corresponding toBgpGlobalBase.getDefaultRouteDistance()
.GracefulRestart
getGracefulRestart()
Return current value associated with the property corresponding toBgpGracefulRestart.getGracefulRestart()
.RouteSelectionOptions
getRouteSelectionOptions()
Return current value associated with the property corresponding toBgpRouteSelectionOptions.getRouteSelectionOptions()
.State
getState()
Return current value associated with the property corresponding toBgpGlobalBase.getState()
.UseMultiplePaths
getUseMultiplePaths()
Return current value associated with the property corresponding toBgpUseMultiplePaths.getUseMultiplePaths()
.GlobalBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Global>> augmentationType)
Remove an augmentation from this builder's product.GlobalBuilder
setAfiSafis(AfiSafis value)
Set the property corresponding toBgpGlobalBase.getAfiSafis()
to the specified value.GlobalBuilder
setApplyPolicy(ApplyPolicy value)
Set the property corresponding toApplyPolicyGroup.getApplyPolicy()
to the specified value.GlobalBuilder
setConfederation(Confederation value)
Set the property corresponding toBgpGlobalBase.getConfederation()
to the specified value.GlobalBuilder
setConfig(Config value)
Set the property corresponding toBgpGlobalBase.getConfig()
to the specified value.GlobalBuilder
setDefaultRouteDistance(DefaultRouteDistance value)
Set the property corresponding toBgpGlobalBase.getDefaultRouteDistance()
to the specified value.GlobalBuilder
setGracefulRestart(GracefulRestart value)
Set the property corresponding toBgpGracefulRestart.getGracefulRestart()
to the specified value.GlobalBuilder
setRouteSelectionOptions(RouteSelectionOptions value)
Set the property corresponding toBgpRouteSelectionOptions.getRouteSelectionOptions()
to the specified value.GlobalBuilder
setState(State value)
Set the property corresponding toBgpGlobalBase.getState()
to the specified value.GlobalBuilder
setUseMultiplePaths(UseMultiplePaths value)
Set the property corresponding toBgpUseMultiplePaths.getUseMultiplePaths()
to the specified value.
-
-
-
Constructor Detail
-
GlobalBuilder
public GlobalBuilder()
Construct an empty builder.
-
GlobalBuilder
public GlobalBuilder(BgpGlobalBase arg)
Construct a new builder initialized from specifiedBgpGlobalBase
.- Parameters:
arg
- BgpGlobalBase from which the builder should be initialized
-
GlobalBuilder
public GlobalBuilder(BgpRouteSelectionOptions arg)
Construct a new builder initialized from specifiedBgpRouteSelectionOptions
.- Parameters:
arg
- BgpRouteSelectionOptions from which the builder should be initialized
-
GlobalBuilder
public GlobalBuilder(BgpUseMultiplePaths arg)
Construct a new builder initialized from specifiedBgpUseMultiplePaths
.- Parameters:
arg
- BgpUseMultiplePaths from which the builder should be initialized
-
GlobalBuilder
public GlobalBuilder(BgpGracefulRestart arg)
Construct a new builder initialized from specifiedBgpGracefulRestart
.- Parameters:
arg
- BgpGracefulRestart from which the builder should be initialized
-
GlobalBuilder
public GlobalBuilder(ApplyPolicyGroup arg)
Construct a new builder initialized from specifiedApplyPolicyGroup
.- Parameters:
arg
- ApplyPolicyGroup 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
-
getAfiSafis
public AfiSafis getAfiSafis()
Return current value associated with the property corresponding toBgpGlobalBase.getAfiSafis()
.- Returns:
- current value
-
getApplyPolicy
public ApplyPolicy getApplyPolicy()
Return current value associated with the property corresponding toApplyPolicyGroup.getApplyPolicy()
.- Returns:
- current value
-
getConfederation
public Confederation getConfederation()
Return current value associated with the property corresponding toBgpGlobalBase.getConfederation()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toBgpGlobalBase.getConfig()
.- Returns:
- current value
-
getDefaultRouteDistance
public DefaultRouteDistance getDefaultRouteDistance()
Return current value associated with the property corresponding toBgpGlobalBase.getDefaultRouteDistance()
.- Returns:
- current value
-
getGracefulRestart
public GracefulRestart getGracefulRestart()
Return current value associated with the property corresponding toBgpGracefulRestart.getGracefulRestart()
.- Returns:
- current value
-
getRouteSelectionOptions
public RouteSelectionOptions getRouteSelectionOptions()
Return current value associated with the property corresponding toBgpRouteSelectionOptions.getRouteSelectionOptions()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toBgpGlobalBase.getState()
.- Returns:
- current value
-
getUseMultiplePaths
public UseMultiplePaths getUseMultiplePaths()
Return current value associated with the property corresponding toBgpUseMultiplePaths.getUseMultiplePaths()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Global>> 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
-
setAfiSafis
public GlobalBuilder setAfiSafis(AfiSafis value)
Set the property corresponding toBgpGlobalBase.getAfiSafis()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setApplyPolicy
public GlobalBuilder setApplyPolicy(ApplyPolicy value)
Set the property corresponding toApplyPolicyGroup.getApplyPolicy()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfederation
public GlobalBuilder setConfederation(Confederation value)
Set the property corresponding toBgpGlobalBase.getConfederation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfig
public GlobalBuilder setConfig(Config value)
Set the property corresponding toBgpGlobalBase.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDefaultRouteDistance
public GlobalBuilder setDefaultRouteDistance(DefaultRouteDistance value)
Set the property corresponding toBgpGlobalBase.getDefaultRouteDistance()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGracefulRestart
public GlobalBuilder setGracefulRestart(GracefulRestart value)
Set the property corresponding toBgpGracefulRestart.getGracefulRestart()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteSelectionOptions
public GlobalBuilder setRouteSelectionOptions(RouteSelectionOptions value)
Set the property corresponding toBgpRouteSelectionOptions.getRouteSelectionOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public GlobalBuilder setState(State value)
Set the property corresponding toBgpGlobalBase.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUseMultiplePaths
public GlobalBuilder setUseMultiplePaths(UseMultiplePaths value)
Set the property corresponding toBgpUseMultiplePaths.getUseMultiplePaths()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GlobalBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Global> 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 GlobalBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Global>> 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
-
-