Class BgpPeerAcceptorConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.peer.acceptor.config.rev200120.BgpPeerAcceptorConfigBuilder
Class that builds
BgpPeerAcceptorConfig
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:
BgpPeerAcceptorConfig createBgpPeerAcceptorConfig(int fooXyzzy, int barBaz) {
return new BgpPeerAcceptorConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BgpPeerAcceptorConfig, 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
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedBgpPeerAcceptorConfig
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull BgpPeerAcceptorConfig
build()
A newBgpPeerAcceptorConfig
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getBindingAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getBindingPort()
.Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getConfigName()
.key()
Return current value associated with the property corresponding toBgpPeerAcceptorConfig.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>> augmentationType) Remove an augmentation from this builder's product.setBindingAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toBgpPeerAcceptorConfig.getBindingAddress()
to the specified value.setBindingPort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpPeerAcceptorConfig.getBindingPort()
to the specified value.setConfigName
(String value) Set the property corresponding toBgpPeerAcceptorConfig.getConfigName()
to the specified value.Set the key value corresponding toBgpPeerAcceptorConfig.key()
to the specified value.
-
Constructor Details
-
BgpPeerAcceptorConfigBuilder
public BgpPeerAcceptorConfigBuilder()Construct an empty builder. -
BgpPeerAcceptorConfigBuilder
Construct a builder initialized with state from specifiedBgpPeerAcceptorConfig
.- Parameters:
base
- BgpPeerAcceptorConfig from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toBgpPeerAcceptorConfig.key()
.- Returns:
- current value
-
getBindingAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getBindingAddress()Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getBindingAddress()
.- Returns:
- current value
-
getBindingPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getBindingPort()Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getBindingPort()
.- Returns:
- current value
-
getConfigName
Return current value associated with the property corresponding toBgpPeerAcceptorConfig.getConfigName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpPeerAcceptorConfig>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toBgpPeerAcceptorConfig.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setBindingAddress
public BgpPeerAcceptorConfigBuilder setBindingAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toBgpPeerAcceptorConfig.getBindingAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBindingPort
public BgpPeerAcceptorConfigBuilder setBindingPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpPeerAcceptorConfig.getBindingPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConfigName
Set the property corresponding toBgpPeerAcceptorConfig.getConfigName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newBgpPeerAcceptorConfig
instance.- Returns:
- A new
BgpPeerAcceptorConfig
instance.
-