Class BgpPeerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.bgp.af.vpn.instance.config.bgppeers.BgpPeerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpPeer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpPeer,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BgpPeerBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BgpPeer>
Class that buildsBgpPeerBuilder
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:
BgpPeerBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpPeerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpPeerBuilder, 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:
BgpPeerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpPeerBuilder()
BgpPeerBuilder(BgpPeer base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpPeerBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BgpPeer
build()
java.lang.String
getDescription()
java.lang.String
getGroupName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getPeerAddr()
java.lang.String
getRemoteAs()
java.lang.String
getSoo()
java.lang.Boolean
isSubstituteAsEnable()
BgpPeerKey
key()
BgpPeerBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>> augmentationType)
BgpPeerBuilder
setDescription(java.lang.String value)
BgpPeerBuilder
setGroupName(java.lang.String value)
BgpPeerBuilder
setPeerAddr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
BgpPeerBuilder
setRemoteAs(java.lang.String value)
BgpPeerBuilder
setSoo(java.lang.String value)
BgpPeerBuilder
setSubstituteAsEnable(java.lang.Boolean value)
BgpPeerBuilder
withKey(BgpPeerKey key)
-
-
-
Constructor Detail
-
BgpPeerBuilder
public BgpPeerBuilder()
-
BgpPeerBuilder
public BgpPeerBuilder(BgpPeer base)
-
-
Method Detail
-
key
public BgpPeerKey key()
-
getDescription
public java.lang.String getDescription()
-
getGroupName
public java.lang.String getGroupName()
-
getPeerAddr
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getPeerAddr()
-
getRemoteAs
public java.lang.String getRemoteAs()
-
getSoo
public java.lang.String getSoo()
-
isSubstituteAsEnable
public java.lang.Boolean isSubstituteAsEnable()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BgpPeerBuilder withKey(BgpPeerKey key)
-
setDescription
public BgpPeerBuilder setDescription(java.lang.String value)
-
setGroupName
public BgpPeerBuilder setGroupName(java.lang.String value)
-
setPeerAddr
public BgpPeerBuilder setPeerAddr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setRemoteAs
public BgpPeerBuilder setRemoteAs(java.lang.String value)
-
setSoo
public BgpPeerBuilder setSoo(java.lang.String value)
-
setSubstituteAsEnable
public BgpPeerBuilder setSubstituteAsEnable(java.lang.Boolean value)
-
addAugmentation
public BgpPeerBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer> augmentationValue)
-
removeAugmentation
public BgpPeerBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeer>> augmentationType)
-
-