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
-
@Generated("mdsal-binding-generator") public class PathsBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description PathsBuilder()
Construct an empty builder.PathsBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.PathsBuilder(ClasstypeObject arg)
Construct a new builder initialized from specifiedClasstypeObject
.PathsBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.PathsBuilder(ExplicitRouteObject arg)
Construct a new builder initialized from specifiedExplicitRouteObject
.PathsBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.PathsBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.PathsBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.PathsBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.PathsBuilder(PathDefinition arg)
Construct a new builder initialized from specifiedPathDefinition
.PathsBuilder(Paths base)
Construct a builder initialized with state from specifiedPaths
.PathsBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.PathsBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Paths
build()
A newPaths
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.ClassType
getClassType()
Return current value associated with the property corresponding toClasstypeObject.getClassType()
.Ero
getEro()
Return current value associated with the property corresponding toExplicitRouteObject.getEro()
.Iro
getIro()
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.Lspa
getLspa()
Return current value associated with the property corresponding toLspaObject.getLspa()
.List<Metrics>
getMetrics()
Return current value associated with the property corresponding toLspAttributes.getMetrics()
.Of
getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.ReoptimizationBandwidth
getReoptimizationBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.Rro
getRro()
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.Xro
getXro()
Return current value associated with the property corresponding toExcludeRouteObject.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)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.PathsBuilder
setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.PathsBuilder
setEro(Ero value)
Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.PathsBuilder
setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.PathsBuilder
setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.PathsBuilder
setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.PathsBuilder
setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.PathsBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.PathsBuilder
setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.PathsBuilder
setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.
-
-
-
Constructor Detail
-
PathsBuilder
public PathsBuilder()
Construct an empty builder.
-
PathsBuilder
public PathsBuilder(PathDefinition arg)
Construct a new builder initialized from specifiedPathDefinition
.- Parameters:
arg
- PathDefinition from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(ExplicitRouteObject arg)
Construct a new builder initialized from specifiedExplicitRouteObject
.- Parameters:
arg
- ExplicitRouteObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.- Parameters:
arg
- LspAttributes from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.- Parameters:
arg
- LspaObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.- Parameters:
arg
- BandwidthObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.- Parameters:
arg
- ReoptimizationBandwidthObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.- Parameters:
arg
- IncludeRouteObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.- Parameters:
arg
- ReportedRouteObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
PathsBuilder
public PathsBuilder(ClasstypeObject arg)
Construct a new builder initialized from specifiedClasstypeObject
.- Parameters:
arg
- ClasstypeObject from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBandwidth
public Bandwidth getBandwidth()
Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.- Returns:
- current value
-
getClassType
public ClassType getClassType()
Return current value associated with the property corresponding toClasstypeObject.getClassType()
.- Returns:
- current value
-
getEro
public Ero getEro()
Return current value associated with the property corresponding toExplicitRouteObject.getEro()
.- Returns:
- current value
-
getIro
public Iro getIro()
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.- Returns:
- current value
-
getLspa
public Lspa getLspa()
Return current value associated with the property corresponding toLspaObject.getLspa()
.- Returns:
- current value
-
getMetrics
public List<Metrics> getMetrics()
Return current value associated with the property corresponding toLspAttributes.getMetrics()
.- Returns:
- current value
-
getOf
public Of getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
getReoptimizationBandwidth
public ReoptimizationBandwidth getReoptimizationBandwidth()
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.- Returns:
- current value
-
getRro
public Rro getRro()
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.- Returns:
- current value
-
getXro
public Xro getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBandwidth
public PathsBuilder setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
public PathsBuilder setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEro
public PathsBuilder setEro(Ero value)
Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIro
public PathsBuilder setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspa
public PathsBuilder setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetrics
public PathsBuilder setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
public PathsBuilder setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReoptimizationBandwidth
public PathsBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRro
public PathsBuilder setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXro
public PathsBuilder setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-