Class NeighborTransportStateAugmentationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.openconfig.extensions.rev180329.network.instance.protocol.NeighborTransportStateAugmentationBuilder
@Generated("mdsal-binding-generator")
public class NeighborTransportStateAugmentationBuilder
extends Object
Class that builds
NeighborTransportStateAugmentation
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:
NeighborTransportStateAugmentation createNeighborTransportStateAugmentation(int fooXyzzy, int barBaz) {
return new NeighborTransportStateAugmentationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NeighborTransportStateAugmentation, 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 specifiedBgpNeighborTransportState
.Construct a builder initialized with state from specifiedNeighborTransportStateAugmentation
. -
Method Summary
Modifier and TypeMethodDescription@NonNull NeighborTransportStateAugmentation
build()
A newNeighborTransportStateAugmentation
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
Return current value associated with the property corresponding toBgpNeighborTransportState.getLocalPort()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
Return current value associated with the property corresponding toBgpNeighborTransportState.getRemoteAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
Return current value associated with the property corresponding toBgpNeighborTransportState.getRemotePort()
.setLocalPort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpNeighborTransportState.getLocalPort()
to the specified value.setRemoteAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toBgpNeighborTransportState.getRemoteAddress()
to the specified value.setRemotePort
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpNeighborTransportState.getRemotePort()
to the specified value.
-
Constructor Details
-
NeighborTransportStateAugmentationBuilder
public NeighborTransportStateAugmentationBuilder()Construct an empty builder. -
NeighborTransportStateAugmentationBuilder
Construct a new builder initialized from specifiedBgpNeighborTransportState
.- Parameters:
arg
- BgpNeighborTransportState from which the builder should be initialized
-
NeighborTransportStateAugmentationBuilder
Construct a builder initialized with state from specifiedNeighborTransportStateAugmentation
.- Parameters:
base
- NeighborTransportStateAugmentation 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
-
getLocalPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPort()Return current value associated with the property corresponding toBgpNeighborTransportState.getLocalPort()
.- Returns:
- current value
-
getRemoteAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRemoteAddress()Return current value associated with the property corresponding toBgpNeighborTransportState.getRemoteAddress()
.- Returns:
- current value
-
getRemotePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePort()Return current value associated with the property corresponding toBgpNeighborTransportState.getRemotePort()
.- Returns:
- current value
-
setLocalPort
public NeighborTransportStateAugmentationBuilder setLocalPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpNeighborTransportState.getLocalPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemoteAddress
public NeighborTransportStateAugmentationBuilder setRemoteAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toBgpNeighborTransportState.getRemoteAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemotePort
public NeighborTransportStateAugmentationBuilder setRemotePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value) Set the property corresponding toBgpNeighborTransportState.getRemotePort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newNeighborTransportStateAugmentation
instance.- Returns:
- A new
NeighborTransportStateAugmentation
instance.
-