Class PathBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcupd.message.pcupd.message.updates.PathBuilder
Class that builds
Path
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.PathBuilder
(Path base) Construct a builder initialized with state from specifiedPath
.Construct a new builder initialized from specifiedBandwidthObject
.Construct a new builder initialized from specifiedClasstypeObject
.Construct a new builder initialized from specifiedExcludeRouteObject
.Construct a new builder initialized from specifiedExplicitRouteObject
.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
.Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.Construct a new builder initialized from specifiedReportedRouteObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Path> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.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.static @NonNull Path
empty()
Get empty instance of Path.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.Return current value associated with the property corresponding toClasstypeObject.getClassType()
.getEro()
Return current value associated with the property corresponding toExplicitRouteObject.getEro()
.getIro()
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.getLspa()
Return current value associated with the property corresponding toLspaObject.getLspa()
.Return current value associated with the property corresponding toLspAttributes.getMetrics()
.getOf()
Return current value associated with the property corresponding toOfObject.getOf()
.Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.getRro()
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.getXro()
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Path>> augmentationType) Remove an augmentation from this builder's product.setBandwidth
(Bandwidth value) Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.setClassType
(ClassType value) Set the property corresponding toClasstypeObject.getClassType()
to the specified value.Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.Set the property corresponding toLspaObject.getLspa()
to the specified value.setMetrics
(List<Metrics> values) Set the property corresponding toLspAttributes.getMetrics()
to the specified value.Set the property corresponding toOfObject.getOf()
to the specified value.Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.Set the property corresponding toReportedRouteObject.getRro()
to the specified value.Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.
-
Constructor Details
-
PathBuilder
public PathBuilder()Construct an empty builder. -
PathBuilder
Construct a new builder initialized from specifiedExplicitRouteObject
.- Parameters:
arg
- ExplicitRouteObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedLspAttributes
.- Parameters:
arg
- LspAttributes from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedLspaObject
.- Parameters:
arg
- LspaObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedBandwidthObject
.- Parameters:
arg
- BandwidthObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedReoptimizationBandwidthObject
.- Parameters:
arg
- ReoptimizationBandwidthObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedIncludeRouteObject
.- Parameters:
arg
- IncludeRouteObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedReportedRouteObject
.- Parameters:
arg
- ReportedRouteObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedExcludeRouteObject
.- Parameters:
arg
- ExcludeRouteObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedOfObject
.- Parameters:
arg
- OfObject from which the builder should be initialized
-
PathBuilder
Construct a new builder initialized from specifiedClasstypeObject
.- Parameters:
arg
- ClasstypeObject from which the builder should be initialized
-
PathBuilder
Construct a builder initialized with state from specifiedPath
.- Parameters:
base
- Path from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of Path.- Returns:
- An empty
Path
-
getBandwidth
Return current value associated with the property corresponding toBandwidthObject.getBandwidth()
.- Returns:
- current value
-
getClassType
Return current value associated with the property corresponding toClasstypeObject.getClassType()
.- Returns:
- current value
-
getEro
Return current value associated with the property corresponding toExplicitRouteObject.getEro()
.- Returns:
- current value
-
getIro
Return current value associated with the property corresponding toIncludeRouteObject.getIro()
.- Returns:
- current value
-
getLspa
Return current value associated with the property corresponding toLspaObject.getLspa()
.- Returns:
- current value
-
getMetrics
Return current value associated with the property corresponding toLspAttributes.getMetrics()
.- Returns:
- current value
-
getOf
Return current value associated with the property corresponding toOfObject.getOf()
.- Returns:
- current value
-
getReoptimizationBandwidth
Return current value associated with the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
.- Returns:
- current value
-
getRro
Return current value associated with the property corresponding toReportedRouteObject.getRro()
.- Returns:
- current value
-
getXro
Return current value associated with the property corresponding toExcludeRouteObject.getXro()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.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
-
setBandwidth
Set the property corresponding toBandwidthObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
Set the property corresponding toClasstypeObject.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEro
Set the property corresponding toExplicitRouteObject.getEro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIro
Set the property corresponding toIncludeRouteObject.getIro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspa
Set the property corresponding toLspaObject.getLspa()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetrics
Set the property corresponding toLspAttributes.getMetrics()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setOf
Set the property corresponding toOfObject.getOf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReoptimizationBandwidth
Set the property corresponding toReoptimizationBandwidthObject.getReoptimizationBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRro
Set the property corresponding toReportedRouteObject.getRro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXro
Set the property corresponding toExcludeRouteObject.getXro()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PathBuilder addAugmentation(org.opendaylight.yangtools.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.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
-
build
A newPath
instance.- Returns:
- A new
Path
instance.
-