Class Neighbor1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.Neighbor1Builder
Class that builds
Neighbor1
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:
Neighbor1 createNeighbor1(int fooXyzzy, int barBaz) {
return new Neighbor1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Neighbor1, 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 specifiedBgpUseMultiplePathsNeighbor
.Neighbor1Builder
(Neighbor1 base) Construct a builder initialized with state from specifiedNeighbor1
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Neighbor1
build()
A newNeighbor1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpUseMultiplePathsNeighbor.getUseMultiplePaths()
.Set the property corresponding toBgpUseMultiplePathsNeighbor.getUseMultiplePaths()
to the specified value.
-
Constructor Details
-
Neighbor1Builder
public Neighbor1Builder()Construct an empty builder. -
Neighbor1Builder
Construct a new builder initialized from specifiedBgpUseMultiplePathsNeighbor
.- Parameters:
arg
- BgpUseMultiplePathsNeighbor from which the builder should be initialized
-
Neighbor1Builder
Construct a builder initialized with state from specifiedNeighbor1
.- Parameters:
base
- Neighbor1 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
-
getUseMultiplePaths
Return current value associated with the property corresponding toBgpUseMultiplePathsNeighbor.getUseMultiplePaths()
.- Returns:
- current value
-
setUseMultiplePaths
Set the property corresponding toBgpUseMultiplePathsNeighbor.getUseMultiplePaths()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newNeighbor1
instance.- Returns:
- A new
Neighbor1
instance.
-