Class ComputedPathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.pcc.configured.lsp.configured.lsp.ComputedPathBuilder
-
@Generated("mdsal-binding-generator") public class ComputedPathBuilder extends Object
Class that buildsComputedPath
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:
ComputedPath createComputedPath(int fooXyzzy, int barBaz) { return new ComputedPathBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ComputedPath, 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:
ComputedPath
- 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 ComputedPathBuilder()
Construct an empty builder.ComputedPathBuilder(PathDescriptions arg)
Construct a new builder initialized from specifiedPathDescriptions
.ComputedPathBuilder(ComputedPath base)
Construct a builder initialized with state from specifiedComputedPath
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ComputedPathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ComputedPath
build()
A newComputedPath
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ComputationStatus
getComputationStatus()
Return current value associated with the property corresponding toComputedPath.getComputationStatus()
.org.opendaylight.yangtools.yang.common.Uint32
getComputedMetric()
Return current value associated with the property corresponding toComputedPath.getComputedMetric()
.List<PathDescription>
getPathDescription()
Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.ComputedPathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath>> augmentationType)
Remove an augmentation from this builder's product.ComputedPathBuilder
setComputationStatus(ComputationStatus value)
Set the property corresponding toComputedPath.getComputationStatus()
to the specified value.ComputedPathBuilder
setComputedMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toComputedPath.getComputedMetric()
to the specified value.ComputedPathBuilder
setPathDescription(List<PathDescription> values)
Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.
-
-
-
Constructor Detail
-
ComputedPathBuilder
public ComputedPathBuilder()
Construct an empty builder.
-
ComputedPathBuilder
public ComputedPathBuilder(PathDescriptions arg)
Construct a new builder initialized from specifiedPathDescriptions
.- Parameters:
arg
- PathDescriptions from which the builder should be initialized
-
ComputedPathBuilder
public ComputedPathBuilder(ComputedPath base)
Construct a builder initialized with state from specifiedComputedPath
.- Parameters:
base
- ComputedPath 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
-
getComputationStatus
public ComputationStatus getComputationStatus()
Return current value associated with the property corresponding toComputedPath.getComputationStatus()
.- Returns:
- current value
-
getComputedMetric
public org.opendaylight.yangtools.yang.common.Uint32 getComputedMetric()
Return current value associated with the property corresponding toComputedPath.getComputedMetric()
.- Returns:
- current value
-
getPathDescription
public List<PathDescription> getPathDescription()
Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath>> 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
-
setComputationStatus
public ComputedPathBuilder setComputationStatus(ComputationStatus value)
Set the property corresponding toComputedPath.getComputationStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setComputedMetric
public ComputedPathBuilder setComputedMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toComputedPath.getComputedMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathDescription
public ComputedPathBuilder setPathDescription(List<PathDescription> values)
Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public ComputedPathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath> 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 ComputedPathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ComputedPath>> 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 @NonNull ComputedPath build()
A newComputedPath
instance.- Returns:
- A new
ComputedPath
instance.
-
-