Class PathsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.success._case.success.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(BandwidthObject arg)
PathsBuilder(ClasstypeObject arg)
PathsBuilder(ExcludeRouteObject arg)
PathsBuilder(ExplicitRouteObject arg)
PathsBuilder(IncludeRouteObject arg)
PathsBuilder(LspaObject arg)
PathsBuilder(LspAttributes arg)
PathsBuilder(OfObject arg)
PathsBuilder(PathDefinition arg)
PathsBuilder(Paths base)
PathsBuilder(ReoptimizationBandwidthObject arg)
PathsBuilder(ReportedRouteObject arg)
-
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()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
ClassType
getClassType()
Ero
getEro()
Iro
getIro()
Lspa
getLspa()
List<Metrics>
getMetrics()
Of
getOf()
ReoptimizationBandwidth
getReoptimizationBandwidth()
Rro
getRro()
Xro
getXro()
PathsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> augmentationType)
Remove an augmentation from this builder's product.PathsBuilder
setBandwidth(Bandwidth value)
PathsBuilder
setClassType(ClassType value)
PathsBuilder
setEro(Ero value)
PathsBuilder
setIro(Iro value)
PathsBuilder
setLspa(Lspa value)
PathsBuilder
setMetrics(List<Metrics> values)
PathsBuilder
setOf(Of value)
PathsBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
PathsBuilder
setRro(Rro value)
PathsBuilder
setXro(Xro value)
-
-
-
Constructor Detail
-
PathsBuilder
public PathsBuilder()
-
PathsBuilder
public PathsBuilder(PathDefinition arg)
-
PathsBuilder
public PathsBuilder(ExplicitRouteObject arg)
-
PathsBuilder
public PathsBuilder(LspAttributes arg)
-
PathsBuilder
public PathsBuilder(LspaObject arg)
-
PathsBuilder
public PathsBuilder(BandwidthObject arg)
-
PathsBuilder
public PathsBuilder(ReoptimizationBandwidthObject arg)
-
PathsBuilder
public PathsBuilder(IncludeRouteObject arg)
-
PathsBuilder
public PathsBuilder(ReportedRouteObject arg)
-
PathsBuilder
public PathsBuilder(ExcludeRouteObject arg)
-
PathsBuilder
public PathsBuilder(OfObject arg)
-
PathsBuilder
public PathsBuilder(ClasstypeObject arg)
-
PathsBuilder
public PathsBuilder(Paths 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:- ClasstypeObject
- ReoptimizationBandwidthObject
- BandwidthObject
- OfObject
- PathDefinition
- ReportedRouteObject
- LspAttributes
- IncludeRouteObject
- ExcludeRouteObject
- LspaObject
- ExplicitRouteObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBandwidth
public Bandwidth getBandwidth()
-
getClassType
public ClassType getClassType()
-
getEro
public Ero getEro()
-
getIro
public Iro getIro()
-
getLspa
public Lspa getLspa()
-
getOf
public Of getOf()
-
getReoptimizationBandwidth
public ReoptimizationBandwidth getReoptimizationBandwidth()
-
getRro
public Rro getRro()
-
getXro
public Xro getXro()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> E$$ augmentation(Class<E$$> augmentationType)
-
setBandwidth
public PathsBuilder setBandwidth(Bandwidth value)
-
setClassType
public PathsBuilder setClassType(ClassType value)
-
setEro
public PathsBuilder setEro(Ero value)
-
setIro
public PathsBuilder setIro(Iro value)
-
setLspa
public PathsBuilder setLspa(Lspa value)
-
setMetrics
public PathsBuilder setMetrics(List<Metrics> values)
-
setOf
public PathsBuilder setOf(Of value)
-
setReoptimizationBandwidth
public PathsBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
-
setRro
public PathsBuilder setRro(Rro value)
-
setXro
public PathsBuilder setXro(Xro 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>
-
-