Class L3UnicastIgpTopology1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.L3UnicastIgpTopology1Builder
Class that builds
L3UnicastIgpTopology1
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:
L3UnicastIgpTopology1 createL3UnicastIgpTopology1(int fooXyzzy, int barBaz) {
return new L3UnicastIgpTopology1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of L3UnicastIgpTopology1, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedL3UnicastIgpTopology1
.Construct a new builder initialized from specifiedOspfTopologyType
. -
Method Summary
Modifier and TypeMethodDescription@NonNull L3UnicastIgpTopology1
build()
A newL3UnicastIgpTopology1
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.getOspf()
Return current value associated with the property corresponding toOspfTopologyType.getOspf()
.Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.
-
Constructor Details
-
L3UnicastIgpTopology1Builder
public L3UnicastIgpTopology1Builder()Construct an empty builder. -
L3UnicastIgpTopology1Builder
Construct a new builder initialized from specifiedOspfTopologyType
.- Parameters:
arg
- OspfTopologyType from which the builder should be initialized
-
L3UnicastIgpTopology1Builder
Construct a builder initialized with state from specifiedL3UnicastIgpTopology1
.- Parameters:
base
- L3UnicastIgpTopology1 from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getOspf
Return current value associated with the property corresponding toOspfTopologyType.getOspf()
.- Returns:
- current value
-
setOspf
Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newL3UnicastIgpTopology1
instance.- Returns:
- A new
L3UnicastIgpTopology1
instance.
-