Class BgpPeerAcceptorConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.peer.acceptor.config.rev200120.BgpPeerAcceptorConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpPeerAcceptorConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpPeerAcceptorConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BgpPeerAcceptorConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BgpPeerAcceptorConfig>
Class that buildsBgpPeerAcceptorConfigBuilder
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:
BgpPeerAcceptorConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpPeerAcceptorConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpPeerAcceptorConfigBuilder, 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:
BgpPeerAcceptorConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpPeerAcceptorConfigBuilder()
BgpPeerAcceptorConfigBuilder(BgpPeerAcceptorConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpPeerAcceptorConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>>
E$$augmentation(Class<E$$> augmentationType)
BgpPeerAcceptorConfig
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getBindingAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getBindingPort()
String
getConfigName()
BgpPeerAcceptorConfigKey
key()
BgpPeerAcceptorConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>> augmentationType)
Remove an augmentation from this builder's product.BgpPeerAcceptorConfigBuilder
setBindingAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
BgpPeerAcceptorConfigBuilder
setBindingPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
BgpPeerAcceptorConfigBuilder
setConfigName(String value)
BgpPeerAcceptorConfigBuilder
withKey(BgpPeerAcceptorConfigKey key)
-
-
-
Constructor Detail
-
BgpPeerAcceptorConfigBuilder
public BgpPeerAcceptorConfigBuilder()
-
BgpPeerAcceptorConfigBuilder
public BgpPeerAcceptorConfigBuilder(BgpPeerAcceptorConfig base)
-
-
Method Detail
-
key
public BgpPeerAcceptorConfigKey key()
-
getBindingAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getBindingAddress()
-
getBindingPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getBindingPort()
-
getConfigName
public String getConfigName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BgpPeerAcceptorConfigBuilder withKey(BgpPeerAcceptorConfigKey key)
-
setBindingAddress
public BgpPeerAcceptorConfigBuilder setBindingAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setBindingPort
public BgpPeerAcceptorConfigBuilder setBindingPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setConfigName
public BgpPeerAcceptorConfigBuilder setConfigName(String value)
-
addAugmentation
public BgpPeerAcceptorConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig> 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 BgpPeerAcceptorConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>> 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 BgpPeerAcceptorConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpPeerAcceptorConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpPeerAcceptorConfig,IllegalArgumentException>
-
-