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