Class PathsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819.network.topology.topology.PathsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Paths>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Paths,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Paths>
Class that buildsPaths
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:
Paths createPaths(int fooXyzzy, int barBaz) { return new PathsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Paths, 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:
Paths
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathsBuilder()
PathsBuilder(Paths base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Paths> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>>
E$$augmentation(Class<E$$> augmentationType)
Paths
build()
PathId
getPathId()
PathTypes
getPathTypes()
PathsKey
key()
PathsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> augmentationType)
Remove an augmentation from this builder's product.PathsBuilder
setPathId(PathId value)
PathsBuilder
setPathTypes(PathTypes value)
PathsBuilder
withKey(PathsKey key)
-
-
-
Constructor Detail
-
PathsBuilder
public PathsBuilder()
-
PathsBuilder
public PathsBuilder(Paths base)
-
-
Method Detail
-
key
public PathsKey key()
-
getPathId
public PathId getPathId()
-
getPathTypes
public PathTypes getPathTypes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PathsBuilder withKey(PathsKey key)
-
setPathId
public PathsBuilder setPathId(PathId value)
-
setPathTypes
public PathsBuilder setPathTypes(PathTypes value)
-
addAugmentation
public PathsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Paths> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public PathsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public Paths build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Paths>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Paths,IllegalArgumentException>
-
-