Class PeerGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.peer.group.PeerGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PeerGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PeerGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PeerGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PeerGroup>
Class that buildsPeerGroupBuilder
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:
PeerGroupBuilder createTarget(int fooXyzzy, int barBaz) { return new PeerGroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PeerGroupBuilder, 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 oportunities, 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:
PeerGroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PeerGroupBuilder()
PeerGroupBuilder(PeerGroup base)
PeerGroupBuilder(BgpGracefulRestart arg)
PeerGroupBuilder(BgpNeighborGroup arg)
PeerGroupBuilder(ApplyPolicyGroup arg)
-
Method Summary
-
-
-
Constructor Detail
-
PeerGroupBuilder
public PeerGroupBuilder()
-
PeerGroupBuilder
public PeerGroupBuilder(BgpNeighborGroup arg)
-
PeerGroupBuilder
public PeerGroupBuilder(BgpGracefulRestart arg)
-
PeerGroupBuilder
public PeerGroupBuilder(ApplyPolicyGroup arg)
-
PeerGroupBuilder
public PeerGroupBuilder(PeerGroup base)
-
-
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:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.BgpGracefulRestart
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.ApplyPolicyGroup
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.BgpNeighborGroup
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public PeerGroupKey key()
-
getAddPaths
public AddPaths getAddPaths()
-
getAfiSafis
public AfiSafis getAfiSafis()
-
getApplyPolicy
public ApplyPolicy getApplyPolicy()
-
getAsPathOptions
public AsPathOptions getAsPathOptions()
-
getConfig
public Config getConfig()
-
getEbgpMultihop
public EbgpMultihop getEbgpMultihop()
-
getErrorHandling
public ErrorHandling getErrorHandling()
-
getGracefulRestart
public GracefulRestart getGracefulRestart()
-
getLoggingOptions
public LoggingOptions getLoggingOptions()
-
getPeerGroupName
public String getPeerGroupName()
-
getRouteReflector
public RouteReflector getRouteReflector()
-
getState
public State getState()
-
getTimers
public Timers getTimers()
-
getTransport
public Transport getTransport()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PeerGroupBuilder withKey(PeerGroupKey key)
-
setAddPaths
public PeerGroupBuilder setAddPaths(AddPaths value)
-
setAfiSafis
public PeerGroupBuilder setAfiSafis(AfiSafis value)
-
setApplyPolicy
public PeerGroupBuilder setApplyPolicy(ApplyPolicy value)
-
setAsPathOptions
public PeerGroupBuilder setAsPathOptions(AsPathOptions value)
-
setConfig
public PeerGroupBuilder setConfig(Config value)
-
setEbgpMultihop
public PeerGroupBuilder setEbgpMultihop(EbgpMultihop value)
-
setErrorHandling
public PeerGroupBuilder setErrorHandling(ErrorHandling value)
-
setGracefulRestart
public PeerGroupBuilder setGracefulRestart(GracefulRestart value)
-
setLoggingOptions
public PeerGroupBuilder setLoggingOptions(LoggingOptions value)
-
setPeerGroupName
public PeerGroupBuilder setPeerGroupName(String value)
-
setRouteReflector
public PeerGroupBuilder setRouteReflector(RouteReflector value)
-
setState
public PeerGroupBuilder setState(State value)
-
setTimers
public PeerGroupBuilder setTimers(Timers value)
-
setTransport
public PeerGroupBuilder setTransport(Transport value)
-
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
-
build
public PeerGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PeerGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PeerGroup,IllegalArgumentException>
-
-