Class AfiSafi2Builder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.AfiSafi2Builder
Class that builds
AfiSafi2
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:
AfiSafi2 createAfiSafi2(int fooXyzzy, int barBaz) {
return new AfiSafi2Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AfiSafi2, 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
.AfiSafi2Builder
(AfiSafi2 base) Construct a builder initialized with state from specifiedAfiSafi2
. -
Method Summary
Modifier and TypeMethodDescription@NonNull AfiSafi2
build()
A newAfiSafi2
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
-
AfiSafi2Builder
public AfiSafi2Builder()Construct an empty builder. -
AfiSafi2Builder
Construct a new builder initialized from specifiedBgpUseMultiplePathsNeighbor
.- Parameters:
arg
- BgpUseMultiplePathsNeighbor from which the builder should be initialized
-
AfiSafi2Builder
Construct a builder initialized with state from specifiedAfiSafi2
.- Parameters:
base
- AfiSafi2 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 newAfiSafi2
instance.- Returns:
- A new
AfiSafi2
instance.
-