Class GetConstrainedPathOutputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.GetConstrainedPathOutputBuilder
Class that builds
GetConstrainedPathOutput
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:
GetConstrainedPathOutput createGetConstrainedPathOutput(int fooXyzzy, int barBaz) {
return new GetConstrainedPathOutputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GetConstrainedPathOutput, 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.Construct a builder initialized with state from specifiedGetConstrainedPathOutput
.Construct a new builder initialized from specifiedPathDescriptions
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GetConstrainedPathOutput
build()
A newGetConstrainedPathOutput
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedDelay()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedMetric()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedTeMetric()
.Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.Return current value associated with the property corresponding toGetConstrainedPathOutput.getStatus()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput>> augmentationType) Remove an augmentation from this builder's product.setComputedDelay
(Delay value) Set the property corresponding toGetConstrainedPathOutput.getComputedDelay()
to the specified value.setComputedMetric
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toGetConstrainedPathOutput.getComputedMetric()
to the specified value.setComputedTeMetric
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toGetConstrainedPathOutput.getComputedTeMetric()
to the specified value.setPathDescription
(List<PathDescription> values) Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.setStatus
(ComputationStatus value) Set the property corresponding toGetConstrainedPathOutput.getStatus()
to the specified value.
-
Constructor Details
-
GetConstrainedPathOutputBuilder
public GetConstrainedPathOutputBuilder()Construct an empty builder. -
GetConstrainedPathOutputBuilder
Construct a new builder initialized from specifiedPathDescriptions
.- Parameters:
arg
- PathDescriptions from which the builder should be initialized
-
GetConstrainedPathOutputBuilder
Construct a builder initialized with state from specifiedGetConstrainedPathOutput
.- Parameters:
base
- GetConstrainedPathOutput 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
-
getComputedDelay
Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedDelay()
.- Returns:
- current value
-
getComputedMetric
public org.opendaylight.yangtools.yang.common.Uint32 getComputedMetric()Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedMetric()
.- Returns:
- current value
-
getComputedTeMetric
public org.opendaylight.yangtools.yang.common.Uint32 getComputedTeMetric()Return current value associated with the property corresponding toGetConstrainedPathOutput.getComputedTeMetric()
.- Returns:
- current value
-
getPathDescription
Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.- Returns:
- current value
-
getStatus
Return current value associated with the property corresponding toGetConstrainedPathOutput.getStatus()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput>> 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
-
setComputedDelay
Set the property corresponding toGetConstrainedPathOutput.getComputedDelay()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setComputedMetric
public GetConstrainedPathOutputBuilder setComputedMetric(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toGetConstrainedPathOutput.getComputedMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setComputedTeMetric
public GetConstrainedPathOutputBuilder setComputedTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toGetConstrainedPathOutput.getComputedTeMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathDescription
Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setStatus
Set the property corresponding toGetConstrainedPathOutput.getStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GetConstrainedPathOutputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput> 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 GetConstrainedPathOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<GetConstrainedPathOutput>> 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 newGetConstrainedPathOutput
instance.- Returns:
- A new
GetConstrainedPathOutput
instance.
-