Class PathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.path.computation.client.reported.lsp.PathBuilder
-
@Generated("mdsal-binding-generator") public class PathBuilder extends Object
Class that buildsPath
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:
Path createPath(int fooXyzzy, int barBaz) { return new PathBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Path, 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:
Path
- 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 PathBuilder()
Construct an empty builder.PathBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.PathBuilder(ClasstypeObject arg)
Construct a new builder initialized from specifiedClasstypeObject
.PathBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.PathBuilder(ExplicitRouteObject arg)
Construct a new builder initialized from specifiedExplicitRouteObject
.PathBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.PathBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.PathBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.PathBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.PathBuilder(PathDefinition arg)
Construct a new builder initialized from specifiedPathDefinition
.PathBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.PathBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.PathBuilder(Path base)
Construct a builder initialized with state from specifiedPath
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Path> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Path
build()
A newPath
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()
.LspId
getLspId()
Return current value associated with the property corresponding toPath.getLspId()
.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()
.PathKey
key()
Return current value associated with the property corresponding toPath.key()
.PathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>> augmentationType)
Remove an augmentation from this builder's product.PathBuilder
setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.PathBuilder
setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.PathBuilder
setEro(Ero value)
Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.PathBuilder
setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.PathBuilder
setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.PathBuilder
setLspId(LspId value)
Set the property corresponding toPath.getLspId()
to the specified value.PathBuilder
setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.PathBuilder
setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.PathBuilder
setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.PathBuilder
setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.PathBuilder
setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.PathBuilder
withKey(PathKey key)
-
-
-
Constructor Detail
-
PathBuilder
public PathBuilder()
Construct an empty builder.
-
PathBuilder
public PathBuilder(PathDefinition arg)
Construct a new builder initialized from specifiedPathDefinition
.- Parameters:
arg
- PathDefinition from which the builder should be initialized
-
PathBuilder
public PathBuilder(ExplicitRouteObject arg)
Construct a new builder initialized from specifiedExplicitRouteObject
.- Parameters:
arg
- ExplicitRouteObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(LspAttributes arg)
Construct a new builder initialized from specifiedLspAttributes
.- Parameters:
arg
- LspAttributes from which the builder should be initialized
-
PathBuilder
public PathBuilder(LspaObject arg)
Construct a new builder initialized from specifiedLspaObject
.- Parameters:
arg
- LspaObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(BandwidthObject arg)
Construct a new builder initialized from specifiedBandwidthObject
.- Parameters:
arg
- BandwidthObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(ReoptimizationBandwidthObject arg)
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.- Parameters:
arg
- ReoptimizationBandwidthObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(IncludeRouteObject arg)
Construct a new builder initialized from specifiedIncludeRouteObject
.- Parameters:
arg
- IncludeRouteObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(ReportedRouteObject arg)
Construct a new builder initialized from specifiedReportedRouteObject
.- Parameters:
arg
- ReportedRouteObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(ExcludeRouteObject arg)
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(OfObject arg)
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
PathBuilder
public PathBuilder(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
-
key
public PathKey key()
Return current value associated with the property corresponding toPath.key()
.- Returns:
- current 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
-
getLspId
public LspId getLspId()
Return current value associated with the property corresponding toPath.getLspId()
.- 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<Path>> 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
-
withKey
public PathBuilder withKey(PathKey key)
-
setBandwidth
public PathBuilder setBandwidth(Bandwidth value)
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
public PathBuilder setClassType(ClassType value)
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEro
public PathBuilder setEro(Ero value)
Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIro
public PathBuilder setIro(Iro value)
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspId
public PathBuilder setLspId(LspId value)
Set the property corresponding toPath.getLspId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspa
public PathBuilder setLspa(Lspa value)
Set the property corresponding toLspaObject.getLspa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetrics
public PathBuilder setMetrics(List<Metrics> values)
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
public PathBuilder setOf(Of value)
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReoptimizationBandwidth
public PathBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRro
public PathBuilder setRro(Rro value)
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXro
public PathBuilder setXro(Xro value)
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Path> 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 PathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Path>> 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
-
-