Class BgpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.nsap.unicast.BgpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Bgp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Bgp,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BgpBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Bgp>
Class that buildsBgpBuilder
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:
BgpBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpBuilder, 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:
BgpBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpBuilder()
BgpBuilder(Bgp base)
BgpBuilder(SlowPeerConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BgpBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Bgp> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BgpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Bgp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Bgp
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AggregateTimer
getAggregateTimer()
Detection
getDetection()
org.opendaylight.yangtools.yang.common.Uint8
getScanTime()
SlowPeerConfig.SplitUpdateGroup
getSplitUpdateGroup()
java.lang.Boolean
isDampening()
java.lang.Boolean
isPropagateDmzlinkBw()
java.lang.Boolean
isRedistributeInternal()
java.lang.Boolean
isSoftReconfigBackup()
BgpBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> augmentationType)
Remove an augmentation from this builder's product.BgpBuilder
setAggregateTimer(AggregateTimer value)
BgpBuilder
setDampening(java.lang.Boolean value)
BgpBuilder
setDetection(Detection value)
BgpBuilder
setPropagateDmzlinkBw(java.lang.Boolean value)
BgpBuilder
setRedistributeInternal(java.lang.Boolean value)
BgpBuilder
setScanTime(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetScanTime(Uint8)
instead.BgpBuilder
setScanTime(org.opendaylight.yangtools.yang.common.Uint8 value)
BgpBuilder
setSoftReconfigBackup(java.lang.Boolean value)
BgpBuilder
setSplitUpdateGroup(SlowPeerConfig.SplitUpdateGroup value)
-
-
-
Constructor Detail
-
BgpBuilder
public BgpBuilder()
-
BgpBuilder
public BgpBuilder(SlowPeerConfig arg)
-
BgpBuilder
public BgpBuilder(Bgp 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.urn.cisco.params.xml.ns.yang.bgp.rev130715.SlowPeerConfig
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getAggregateTimer
public AggregateTimer getAggregateTimer()
-
getDetection
public Detection getDetection()
-
getScanTime
public org.opendaylight.yangtools.yang.common.Uint8 getScanTime()
-
getSplitUpdateGroup
public SlowPeerConfig.SplitUpdateGroup getSplitUpdateGroup()
-
isDampening
public java.lang.Boolean isDampening()
-
isPropagateDmzlinkBw
public java.lang.Boolean isPropagateDmzlinkBw()
-
isRedistributeInternal
public java.lang.Boolean isRedistributeInternal()
-
isSoftReconfigBackup
public java.lang.Boolean isSoftReconfigBackup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAggregateTimer
public BgpBuilder setAggregateTimer(AggregateTimer value)
-
setDetection
public BgpBuilder setDetection(Detection value)
-
setScanTime
public BgpBuilder setScanTime(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setScanTime
@Deprecated(forRemoval=true) public BgpBuilder setScanTime(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetScanTime(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSplitUpdateGroup
public BgpBuilder setSplitUpdateGroup(SlowPeerConfig.SplitUpdateGroup value)
-
setDampening
public BgpBuilder setDampening(java.lang.Boolean value)
-
setPropagateDmzlinkBw
public BgpBuilder setPropagateDmzlinkBw(java.lang.Boolean value)
-
setRedistributeInternal
public BgpBuilder setRedistributeInternal(java.lang.Boolean value)
-
setSoftReconfigBackup
public BgpBuilder setSoftReconfigBackup(java.lang.Boolean value)
-
addAugmentation
public BgpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Bgp> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public BgpBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Bgp> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public BgpBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bgp>> 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
-
-