Class PeerGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroupBuilder
-
@Generated("mdsal-binding-generator") public class PeerGroupBuilder extends Object
Class that buildsPeerGroup
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:
PeerGroup createPeerGroup(int fooXyzzy, int barBaz) { return new PeerGroupBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerGroup, 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:
PeerGroup
- 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 PeerGroupBuilder()
Construct an empty builder.PeerGroupBuilder(PeerGroup base)
Construct a builder initialized with state from specifiedPeerGroup
.PeerGroupBuilder(BgpGracefulRestart arg)
Construct a new builder initialized from specifiedBgpGracefulRestart
.PeerGroupBuilder(BgpNeighborGroup arg)
Construct a new builder initialized from specifiedBgpNeighborGroup
.PeerGroupBuilder(ApplyPolicyGroup arg)
Construct a new builder initialized from specifiedApplyPolicyGroup
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PeerGroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PeerGroup
build()
A newPeerGroup
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AddPaths
getAddPaths()
Return current value associated with the property corresponding toBgpNeighborGroup.getAddPaths()
.AfiSafis
getAfiSafis()
Return current value associated with the property corresponding toBgpNeighborGroup.getAfiSafis()
.ApplyPolicy
getApplyPolicy()
Return current value associated with the property corresponding toApplyPolicyGroup.getApplyPolicy()
.AsPathOptions
getAsPathOptions()
Return current value associated with the property corresponding toBgpNeighborGroup.getAsPathOptions()
.Config
getConfig()
Return current value associated with the property corresponding toBgpNeighborGroup.getConfig()
.EbgpMultihop
getEbgpMultihop()
Return current value associated with the property corresponding toBgpNeighborGroup.getEbgpMultihop()
.ErrorHandling
getErrorHandling()
Return current value associated with the property corresponding toBgpNeighborGroup.getErrorHandling()
.GracefulRestart
getGracefulRestart()
Return current value associated with the property corresponding toBgpGracefulRestart.getGracefulRestart()
.LoggingOptions
getLoggingOptions()
Return current value associated with the property corresponding toBgpNeighborGroup.getLoggingOptions()
.String
getPeerGroupName()
Return current value associated with the property corresponding toPeerGroup.getPeerGroupName()
.RouteReflector
getRouteReflector()
Return current value associated with the property corresponding toBgpNeighborGroup.getRouteReflector()
.State
getState()
Return current value associated with the property corresponding toBgpNeighborGroup.getState()
.Timers
getTimers()
Return current value associated with the property corresponding toBgpNeighborGroup.getTimers()
.Transport
getTransport()
Return current value associated with the property corresponding toBgpNeighborGroup.getTransport()
.PeerGroupKey
key()
Return current value associated with the property corresponding toPeerGroup.key()
.PeerGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup>> augmentationType)
Remove an augmentation from this builder's product.PeerGroupBuilder
setAddPaths(AddPaths value)
Set the property corresponding toBgpNeighborGroup.getAddPaths()
to the specified value.PeerGroupBuilder
setAfiSafis(AfiSafis value)
Set the property corresponding toBgpNeighborGroup.getAfiSafis()
to the specified value.PeerGroupBuilder
setApplyPolicy(ApplyPolicy value)
Set the property corresponding toApplyPolicyGroup.getApplyPolicy()
to the specified value.PeerGroupBuilder
setAsPathOptions(AsPathOptions value)
Set the property corresponding toBgpNeighborGroup.getAsPathOptions()
to the specified value.PeerGroupBuilder
setConfig(Config value)
Set the property corresponding toBgpNeighborGroup.getConfig()
to the specified value.PeerGroupBuilder
setEbgpMultihop(EbgpMultihop value)
Set the property corresponding toBgpNeighborGroup.getEbgpMultihop()
to the specified value.PeerGroupBuilder
setErrorHandling(ErrorHandling value)
Set the property corresponding toBgpNeighborGroup.getErrorHandling()
to the specified value.PeerGroupBuilder
setGracefulRestart(GracefulRestart value)
Set the property corresponding toBgpGracefulRestart.getGracefulRestart()
to the specified value.PeerGroupBuilder
setLoggingOptions(LoggingOptions value)
Set the property corresponding toBgpNeighborGroup.getLoggingOptions()
to the specified value.PeerGroupBuilder
setPeerGroupName(String value)
Set the property corresponding toPeerGroup.getPeerGroupName()
to the specified value.PeerGroupBuilder
setRouteReflector(RouteReflector value)
Set the property corresponding toBgpNeighborGroup.getRouteReflector()
to the specified value.PeerGroupBuilder
setState(State value)
Set the property corresponding toBgpNeighborGroup.getState()
to the specified value.PeerGroupBuilder
setTimers(Timers value)
Set the property corresponding toBgpNeighborGroup.getTimers()
to the specified value.PeerGroupBuilder
setTransport(Transport value)
Set the property corresponding toBgpNeighborGroup.getTransport()
to the specified value.PeerGroupBuilder
withKey(PeerGroupKey key)
-
-
-
Constructor Detail
-
PeerGroupBuilder
public PeerGroupBuilder()
Construct an empty builder.
-
PeerGroupBuilder
public PeerGroupBuilder(BgpNeighborGroup arg)
Construct a new builder initialized from specifiedBgpNeighborGroup
.- Parameters:
arg
- BgpNeighborGroup from which the builder should be initialized
-
PeerGroupBuilder
public PeerGroupBuilder(BgpGracefulRestart arg)
Construct a new builder initialized from specifiedBgpGracefulRestart
.- Parameters:
arg
- BgpGracefulRestart from which the builder should be initialized
-
PeerGroupBuilder
public PeerGroupBuilder(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
-
key
public PeerGroupKey key()
Return current value associated with the property corresponding toPeerGroup.key()
.- Returns:
- current value
-
getAddPaths
public AddPaths getAddPaths()
Return current value associated with the property corresponding toBgpNeighborGroup.getAddPaths()
.- Returns:
- current value
-
getAfiSafis
public AfiSafis getAfiSafis()
Return current value associated with the property corresponding toBgpNeighborGroup.getAfiSafis()
.- Returns:
- current value
-
getApplyPolicy
public ApplyPolicy getApplyPolicy()
Return current value associated with the property corresponding toApplyPolicyGroup.getApplyPolicy()
.- Returns:
- current value
-
getAsPathOptions
public AsPathOptions getAsPathOptions()
Return current value associated with the property corresponding toBgpNeighborGroup.getAsPathOptions()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toBgpNeighborGroup.getConfig()
.- Returns:
- current value
-
getEbgpMultihop
public EbgpMultihop getEbgpMultihop()
Return current value associated with the property corresponding toBgpNeighborGroup.getEbgpMultihop()
.- Returns:
- current value
-
getErrorHandling
public ErrorHandling getErrorHandling()
Return current value associated with the property corresponding toBgpNeighborGroup.getErrorHandling()
.- Returns:
- current value
-
getGracefulRestart
public GracefulRestart getGracefulRestart()
Return current value associated with the property corresponding toBgpGracefulRestart.getGracefulRestart()
.- Returns:
- current value
-
getLoggingOptions
public LoggingOptions getLoggingOptions()
Return current value associated with the property corresponding toBgpNeighborGroup.getLoggingOptions()
.- Returns:
- current value
-
getPeerGroupName
public String getPeerGroupName()
Return current value associated with the property corresponding toPeerGroup.getPeerGroupName()
.- Returns:
- current value
-
getRouteReflector
public RouteReflector getRouteReflector()
Return current value associated with the property corresponding toBgpNeighborGroup.getRouteReflector()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toBgpNeighborGroup.getState()
.- Returns:
- current value
-
getTimers
public Timers getTimers()
Return current value associated with the property corresponding toBgpNeighborGroup.getTimers()
.- Returns:
- current value
-
getTransport
public Transport getTransport()
Return current value associated with the property corresponding toBgpNeighborGroup.getTransport()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup>> 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
-
withKey
public PeerGroupBuilder withKey(PeerGroupKey key)
-
setAddPaths
public PeerGroupBuilder setAddPaths(AddPaths value)
Set the property corresponding toBgpNeighborGroup.getAddPaths()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAfiSafis
public PeerGroupBuilder setAfiSafis(AfiSafis value)
Set the property corresponding toBgpNeighborGroup.getAfiSafis()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setApplyPolicy
public PeerGroupBuilder setApplyPolicy(ApplyPolicy value)
Set the property corresponding toApplyPolicyGroup.getApplyPolicy()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAsPathOptions
public PeerGroupBuilder setAsPathOptions(AsPathOptions value)
Set the property corresponding toBgpNeighborGroup.getAsPathOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfig
public PeerGroupBuilder setConfig(Config value)
Set the property corresponding toBgpNeighborGroup.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEbgpMultihop
public PeerGroupBuilder setEbgpMultihop(EbgpMultihop value)
Set the property corresponding toBgpNeighborGroup.getEbgpMultihop()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setErrorHandling
public PeerGroupBuilder setErrorHandling(ErrorHandling value)
Set the property corresponding toBgpNeighborGroup.getErrorHandling()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGracefulRestart
public PeerGroupBuilder setGracefulRestart(GracefulRestart value)
Set the property corresponding toBgpGracefulRestart.getGracefulRestart()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLoggingOptions
public PeerGroupBuilder setLoggingOptions(LoggingOptions value)
Set the property corresponding toBgpNeighborGroup.getLoggingOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPeerGroupName
public PeerGroupBuilder setPeerGroupName(String value)
Set the property corresponding toPeerGroup.getPeerGroupName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteReflector
public PeerGroupBuilder setRouteReflector(RouteReflector value)
Set the property corresponding toBgpNeighborGroup.getRouteReflector()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public PeerGroupBuilder setState(State value)
Set the property corresponding toBgpNeighborGroup.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTimers
public PeerGroupBuilder setTimers(Timers value)
Set the property corresponding toBgpNeighborGroup.getTimers()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransport
public PeerGroupBuilder setTransport(Transport value)
Set the property corresponding toBgpNeighborGroup.getTransport()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PeerGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup> 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 PeerGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup>> 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
-
-