Class GetConstrainedPathInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.GetConstrainedPathInputBuilder
-
@Generated("mdsal-binding-generator") public class GetConstrainedPathInputBuilder extends Object
Class that buildsGetConstrainedPathInput
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:
GetConstrainedPathInput createGetConstrainedPathInput(int fooXyzzy, int barBaz) { return new GetConstrainedPathInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetConstrainedPathInput, 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:
GetConstrainedPathInput
- 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 GetConstrainedPathInputBuilder()
Construct an empty builder.GetConstrainedPathInputBuilder(GetConstrainedPathInput base)
Construct a builder initialized with state from specifiedGetConstrainedPathInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetConstrainedPathInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull GetConstrainedPathInput
build()
A newGetConstrainedPathInput
instance.AlgorithmType
getAlgorithm()
Return current value associated with the property corresponding toGetConstrainedPathInput.getAlgorithm()
.Constraints
getConstraints()
Return current value associated with the property corresponding toGetConstrainedPathInput.getConstraints()
.org.opendaylight.yangtools.yang.common.Uint64
getDestination()
Return current value associated with the property corresponding toGetConstrainedPathInput.getDestination()
.String
getGraphName()
Return current value associated with the property corresponding toGetConstrainedPathInput.getGraphName()
.org.opendaylight.yangtools.yang.common.Uint64
getSource()
Return current value associated with the property corresponding toGetConstrainedPathInput.getSource()
.GetConstrainedPathInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> augmentationType)
Remove an augmentation from this builder's product.GetConstrainedPathInputBuilder
setAlgorithm(AlgorithmType value)
Set the property corresponding toGetConstrainedPathInput.getAlgorithm()
to the specified value.GetConstrainedPathInputBuilder
setConstraints(Constraints value)
Set the property corresponding toGetConstrainedPathInput.getConstraints()
to the specified value.GetConstrainedPathInputBuilder
setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toGetConstrainedPathInput.getDestination()
to the specified value.GetConstrainedPathInputBuilder
setGraphName(String value)
Set the property corresponding toGetConstrainedPathInput.getGraphName()
to the specified value.GetConstrainedPathInputBuilder
setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toGetConstrainedPathInput.getSource()
to the specified value.
-
-
-
Constructor Detail
-
GetConstrainedPathInputBuilder
public GetConstrainedPathInputBuilder()
Construct an empty builder.
-
GetConstrainedPathInputBuilder
public GetConstrainedPathInputBuilder(GetConstrainedPathInput base)
Construct a builder initialized with state from specifiedGetConstrainedPathInput
.- Parameters:
base
- GetConstrainedPathInput from which the builder should be initialized
-
-
Method Detail
-
getAlgorithm
public AlgorithmType getAlgorithm()
Return current value associated with the property corresponding toGetConstrainedPathInput.getAlgorithm()
.- Returns:
- current value
-
getConstraints
public Constraints getConstraints()
Return current value associated with the property corresponding toGetConstrainedPathInput.getConstraints()
.- Returns:
- current value
-
getDestination
public org.opendaylight.yangtools.yang.common.Uint64 getDestination()
Return current value associated with the property corresponding toGetConstrainedPathInput.getDestination()
.- Returns:
- current value
-
getGraphName
public String getGraphName()
Return current value associated with the property corresponding toGetConstrainedPathInput.getGraphName()
.- Returns:
- current value
-
getSource
public org.opendaylight.yangtools.yang.common.Uint64 getSource()
Return current value associated with the property corresponding toGetConstrainedPathInput.getSource()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> 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
-
setAlgorithm
public GetConstrainedPathInputBuilder setAlgorithm(AlgorithmType value)
Set the property corresponding toGetConstrainedPathInput.getAlgorithm()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConstraints
public GetConstrainedPathInputBuilder setConstraints(Constraints value)
Set the property corresponding toGetConstrainedPathInput.getConstraints()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDestination
public GetConstrainedPathInputBuilder setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toGetConstrainedPathInput.getDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGraphName
public GetConstrainedPathInputBuilder setGraphName(String value)
Set the property corresponding toGetConstrainedPathInput.getGraphName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSource
public GetConstrainedPathInputBuilder setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toGetConstrainedPathInput.getSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GetConstrainedPathInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput> 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 GetConstrainedPathInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> 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 GetConstrainedPathInput build()
A newGetConstrainedPathInput
instance.- Returns:
- A new
GetConstrainedPathInput
instance.
-
-