Class PeerGroupBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<PeerGroup,PeerGroupBuilder>
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroupBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class PeerGroupBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<PeerGroup,PeerGroupBuilder>
Class that builds
PeerGroup 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.PeerGroupBuilder(PeerGroup base) Construct a builder initialized with state from specifiedPeerGroup.Construct a new builder initialized from specifiedBgpGracefulRestart.Construct a new builder initialized from specifiedBgpNeighborGroup.Construct a new builder initialized from specifiedApplyPolicyGroup. -
Method Summary
Modifier and TypeMethodDescription@NonNull PeerGroupbuild()Returns A newPeerGroupinstance.voidfieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasegetState()Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasekey()Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasesetAddPaths(AddPaths value) Set the property corresponding toBgpNeighborGroup.getAddPaths()to the specified value.setAfiSafis(AfiSafis value) Set the property corresponding toBgpNeighborGroup.getAfiSafis()to the specified value.setApplyPolicy(ApplyPolicy value) Set the property corresponding toApplyPolicyGroup.getApplyPolicy()to the specified value.setAsPathOptions(AsPathOptions value) Set the property corresponding toBgpNeighborGroup.getAsPathOptions()to the specified value.Set the property corresponding toBgpNeighborGroup.getConfig()to the specified value.setEbgpMultihop(EbgpMultihop value) Set the property corresponding toBgpNeighborGroup.getEbgpMultihop()to the specified value.setErrorHandling(ErrorHandling value) Set the property corresponding toBgpNeighborGroup.getErrorHandling()to the specified value.Set the property corresponding toBgpGracefulRestart.getGracefulRestart()to the specified value.setLoggingOptions(LoggingOptions value) Set the property corresponding toBgpNeighborGroup.getLoggingOptions()to the specified value.setPeerGroupName(String value) Set the property corresponding toPeerGroup.getPeerGroupName()to the specified value.setRouteReflector(RouteReflector value) Set the property corresponding toBgpNeighborGroup.getRouteReflector()to the specified value.Set the property corresponding toBgpNeighborGroup.getState()to the specified value.Set the property corresponding toBgpNeighborGroup.getTimers()to the specified value.setTransport(Transport value) Set the property corresponding toBgpNeighborGroup.getTransport()to the specified value.withKey(PeerGroupKey key) Set the key value corresponding toEntryObject.key()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
PeerGroupBuilder
public PeerGroupBuilder()Construct an empty builder. -
PeerGroupBuilder
Construct a new builder initialized from specifiedBgpNeighborGroup.- Parameters:
arg- BgpNeighborGroup from which the builder should be initialized
-
PeerGroupBuilder
Construct a new builder initialized from specifiedBgpGracefulRestart.- Parameters:
arg- BgpGracefulRestart from which the builder should be initialized
-
PeerGroupBuilder
Construct a new builder initialized from specifiedApplyPolicyGroup.- Parameters:
arg- ApplyPolicyGroup from which the builder should be initialized
-
PeerGroupBuilder
Construct a builder initialized with state from specifiedPeerGroup.- Parameters:
base- PeerGroup from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toEntryObject.key().- Returns:
- current value
-
getAddPaths
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getAddPaths().- Returns:
- current value
-
getAfiSafis
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getAfiSafis().- Returns:
- current value
-
getApplyPolicy
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toApplyPolicyGroup.getApplyPolicy().- Returns:
- current value
-
getAsPathOptions
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getAsPathOptions().- Returns:
- current value
-
getConfig
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getConfig().- Returns:
- current value
-
getEbgpMultihop
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getEbgpMultihop().- Returns:
- current value
-
getErrorHandling
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getErrorHandling().- Returns:
- current value
-
getGracefulRestart
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpGracefulRestart.getGracefulRestart().- Returns:
- current value
-
getLoggingOptions
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getLoggingOptions().- Returns:
- current value
-
getPeerGroupName
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toPeerGroup.getPeerGroupName().- Returns:
- current value
-
getRouteReflector
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getRouteReflector().- Returns:
- current value
-
getState
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getState().- Returns:
- current value
-
getTimers
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getTimers().- Returns:
- current value
-
getTransport
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toBgpNeighborGroup.getTransport().- Returns:
- current value
-
withKey
Set the key value corresponding toEntryObject.key()to the specified value.- Parameters:
key- desired value- Returns:
- this builder
-
setAddPaths
Set the property corresponding toBgpNeighborGroup.getAddPaths()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAfiSafis
Set the property corresponding toBgpNeighborGroup.getAfiSafis()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setApplyPolicy
Set the property corresponding toApplyPolicyGroup.getApplyPolicy()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setAsPathOptions
Set the property corresponding toBgpNeighborGroup.getAsPathOptions()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setConfig
Set the property corresponding toBgpNeighborGroup.getConfig()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setEbgpMultihop
Set the property corresponding toBgpNeighborGroup.getEbgpMultihop()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setErrorHandling
Set the property corresponding toBgpNeighborGroup.getErrorHandling()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setGracefulRestart
Set the property corresponding toBgpGracefulRestart.getGracefulRestart()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setLoggingOptions
Set the property corresponding toBgpNeighborGroup.getLoggingOptions()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPeerGroupName
Set the property corresponding toPeerGroup.getPeerGroupName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setRouteReflector
Set the property corresponding toBgpNeighborGroup.getRouteReflector()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setState
Set the property corresponding toBgpNeighborGroup.getState()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setTimers
Set the property corresponding toBgpNeighborGroup.getTimers()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setTransport
Set the property corresponding toBgpNeighborGroup.getTransport()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newPeerGroupinstance.- Returns:
- A new
PeerGroupinstance
-