Class NeighborAddPathsConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborAddPathsConfigBuilder
Class that builds
NeighborAddPathsConfig
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:
NeighborAddPathsConfig createNeighborAddPathsConfig(int fooXyzzy, int barBaz) {
return new NeighborAddPathsConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NeighborAddPathsConfig, 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 new builder initialized from specifiedBgpNeighborAddPathsConfig
.Construct a builder initialized with state from specifiedNeighborAddPathsConfig
. -
Method Summary
Modifier and TypeMethodDescription@NonNull NeighborAddPathsConfig
build()
A newNeighborAddPathsConfig
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpNeighborAddPathsConfig.getReceive()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toBgpNeighborAddPathsConfig.getSendMax()
.setReceive
(Boolean value) Set the property corresponding toBgpNeighborAddPathsConfig.getReceive()
to the specified value.setSendMax
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toBgpNeighborAddPathsConfig.getSendMax()
to the specified value.
-
Constructor Details
-
NeighborAddPathsConfigBuilder
public NeighborAddPathsConfigBuilder()Construct an empty builder. -
NeighborAddPathsConfigBuilder
Construct a new builder initialized from specifiedBgpNeighborAddPathsConfig
.- Parameters:
arg
- BgpNeighborAddPathsConfig from which the builder should be initialized
-
NeighborAddPathsConfigBuilder
Construct a builder initialized with state from specifiedNeighborAddPathsConfig
.- Parameters:
base
- NeighborAddPathsConfig from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getReceive
Return current value associated with the property corresponding toBgpNeighborAddPathsConfig.getReceive()
.- Returns:
- current value
-
getSendMax
public org.opendaylight.yangtools.yang.common.Uint8 getSendMax()Return current value associated with the property corresponding toBgpNeighborAddPathsConfig.getSendMax()
.- Returns:
- current value
-
setReceive
Set the property corresponding toBgpNeighborAddPathsConfig.getReceive()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSendMax
Set the property corresponding toBgpNeighborAddPathsConfig.getSendMax()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newNeighborAddPathsConfig
instance.- Returns:
- A new
NeighborAddPathsConfig
instance.
-