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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Path1>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Path1,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Path1Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<Path1>
Class that buildsPath1
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:
Path1
,Builder
-
-
Constructor Summary
Constructors Constructor Description Path1Builder()
Path1Builder(LspObject arg)
Path1Builder(Path1 base)
Path1Builder(PathSetupTypeTlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Path1
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Lsp
getLsp()
PathSetupType
getPathSetupType()
Path1Builder
setLsp(Lsp value)
Path1Builder
setPathSetupType(PathSetupType value)
-
-
-
Constructor Detail
-
Path1Builder
public Path1Builder()
-
Path1Builder
public Path1Builder(LspObject arg)
-
Path1Builder
public Path1Builder(PathSetupTypeTlv arg)
-
Path1Builder
public Path1Builder(Path1 base)
-
-
Method Detail
-
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:- LspObject
- PathSetupTypeTlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLsp
public Lsp getLsp()
-
getPathSetupType
public PathSetupType getPathSetupType()
-
setLsp
public Path1Builder setLsp(Lsp value)
-
setPathSetupType
public Path1Builder setPathSetupType(PathSetupType value)
-
build
public Path1 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Path1>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Path1,IllegalArgumentException>
-
-