Class State7Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State7Builder
Class that builds
State7
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:
State7 createState7(int fooXyzzy, int barBaz) {
return new State7Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of State7, 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 specifiedBgpNeighborNeighborAddressConfig
.State7Builder
(State7 base) Construct a builder initialized with state from specifiedState7
. -
Method Summary
Modifier and TypeMethodDescription@NonNull State7
build()
A newState7
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.IpAddress
Return current value associated with the property corresponding toBgpNeighborNeighborAddressConfig.getNeighborAddress()
.setNeighborAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toBgpNeighborNeighborAddressConfig.getNeighborAddress()
to the specified value.
-
Constructor Details
-
State7Builder
public State7Builder()Construct an empty builder. -
State7Builder
Construct a new builder initialized from specifiedBgpNeighborNeighborAddressConfig
.- Parameters:
arg
- BgpNeighborNeighborAddressConfig from which the builder should be initialized
-
State7Builder
Construct a builder initialized with state from specifiedState7
.- Parameters:
base
- State7 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
-
getNeighborAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNeighborAddress()Return current value associated with the property corresponding toBgpNeighborNeighborAddressConfig.getNeighborAddress()
.- Returns:
- current value
-
setNeighborAddress
public State7Builder setNeighborAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toBgpNeighborNeighborAddressConfig.getNeighborAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newState7
instance.- Returns:
- A new
State7
instance.
-