Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720
Class Path1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.Path1Builder
Class that builds
Path1
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:
Path1 createPath1(int fooXyzzy, int barBaz) {
return new Path1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Path1, 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.Path1Builder
(LspObject arg) Construct a new builder initialized from specifiedLspObject
.Path1Builder
(Path1 base) Construct a builder initialized with state from specifiedPath1
.Construct a new builder initialized from specifiedPathSetupTypeTlv
. -
Method Summary
Modifier and TypeMethodDescription@NonNull Path1
build()
A newPath1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getLsp()
Return current value associated with the property corresponding toLspObject.getLsp()
.Return current value associated with the property corresponding toPathSetupTypeTlv.getPathSetupType()
.Set the property corresponding toLspObject.getLsp()
to the specified value.setPathSetupType
(PathSetupType value) Set the property corresponding toPathSetupTypeTlv.getPathSetupType()
to the specified value.
-
Constructor Details
-
Path1Builder
public Path1Builder()Construct an empty builder. -
Path1Builder
Construct a new builder initialized from specifiedLspObject
.- Parameters:
arg
- LspObject from which the builder should be initialized
-
Path1Builder
Construct a new builder initialized from specifiedPathSetupTypeTlv
.- Parameters:
arg
- PathSetupTypeTlv from which the builder should be initialized
-
Path1Builder
Construct a builder initialized with state from specifiedPath1
.- Parameters:
base
- Path1 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
-
getLsp
Return current value associated with the property corresponding toLspObject.getLsp()
.- Returns:
- current value
-
getPathSetupType
Return current value associated with the property corresponding toPathSetupTypeTlv.getPathSetupType()
.- Returns:
- current value
-
setLsp
Set the property corresponding toLspObject.getLsp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathSetupType
Set the property corresponding toPathSetupTypeTlv.getPathSetupType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newPath1
instance.- Returns:
- A new
Path1
instance.
-