Class GetConstrainedPathOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.GetConstrainedPathOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GetConstrainedPathOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GetConstrainedPathOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class GetConstrainedPathOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GetConstrainedPathOutput>
Class that buildsGetConstrainedPathOutputBuilder
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:
GetConstrainedPathOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetConstrainedPathOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetConstrainedPathOutputBuilder, 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 oportunities, 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:
GetConstrainedPathOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetConstrainedPathOutputBuilder()
GetConstrainedPathOutputBuilder(GetConstrainedPathOutput base)
GetConstrainedPathOutputBuilder(PathDescriptions arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GetConstrainedPathOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathOutput>>
E$$augmentation(Class<E$$> augmentationType)
GetConstrainedPathOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Delay
getComputedDelay()
org.opendaylight.yangtools.yang.common.Uint32
getComputedMetric()
org.opendaylight.yangtools.yang.common.Uint32
getComputedTeMetric()
List<PathDescription>
getPathDescription()
ComputationStatus
getStatus()
GetConstrainedPathOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathOutput>> augmentationType)
Remove an augmentation from this builder's product.GetConstrainedPathOutputBuilder
setComputedDelay(Delay value)
GetConstrainedPathOutputBuilder
setComputedMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetComputedMetric(Uint32)
instead.GetConstrainedPathOutputBuilder
setComputedMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
GetConstrainedPathOutputBuilder
setComputedTeMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetComputedTeMetric(Uint32)
instead.GetConstrainedPathOutputBuilder
setComputedTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
GetConstrainedPathOutputBuilder
setPathDescription(List<PathDescription> values)
GetConstrainedPathOutputBuilder
setStatus(ComputationStatus value)
-
-
-
Constructor Detail
-
GetConstrainedPathOutputBuilder
public GetConstrainedPathOutputBuilder()
-
GetConstrainedPathOutputBuilder
public GetConstrainedPathOutputBuilder(PathDescriptions arg)
-
GetConstrainedPathOutputBuilder
public GetConstrainedPathOutputBuilder(GetConstrainedPathOutput base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.PathDescriptions
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getComputedDelay
public Delay getComputedDelay()
-
getComputedMetric
public org.opendaylight.yangtools.yang.common.Uint32 getComputedMetric()
-
getComputedTeMetric
public org.opendaylight.yangtools.yang.common.Uint32 getComputedTeMetric()
-
getPathDescription
public List<PathDescription> getPathDescription()
-
getStatus
public ComputationStatus getStatus()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
setComputedDelay
public GetConstrainedPathOutputBuilder setComputedDelay(Delay value)
-
setComputedMetric
public GetConstrainedPathOutputBuilder setComputedMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setComputedMetric
@Deprecated(forRemoval=true) public GetConstrainedPathOutputBuilder setComputedMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetComputedMetric(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setComputedTeMetric
public GetConstrainedPathOutputBuilder setComputedTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setComputedTeMetric
@Deprecated(forRemoval=true) public GetConstrainedPathOutputBuilder setComputedTeMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetComputedTeMetric(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPathDescription
public GetConstrainedPathOutputBuilder setPathDescription(List<PathDescription> values)
-
setStatus
public GetConstrainedPathOutputBuilder setStatus(ComputationStatus value)
-
addAugmentation
public GetConstrainedPathOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
public GetConstrainedPathOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GetConstrainedPathOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GetConstrainedPathOutput,IllegalArgumentException>
-
-