Class GetConstrainedPathInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev200120.GetConstrainedPathInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<GetConstrainedPathInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<GetConstrainedPathInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GetConstrainedPathInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<GetConstrainedPathInput>
Class that buildsGetConstrainedPathInputBuilder
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:
GetConstrainedPathInputBuilder createTarget(int fooXyzzy, int barBaz) { return new GetConstrainedPathInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GetConstrainedPathInputBuilder, 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:
GetConstrainedPathInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description GetConstrainedPathInputBuilder()
GetConstrainedPathInputBuilder(GetConstrainedPathInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GetConstrainedPathInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>>
E$$augmentation(Class<E$$> augmentationType)
GetConstrainedPathInput
build()
AlgorithmType
getAlgorithm()
Constraints
getConstraints()
org.opendaylight.yangtools.yang.common.Uint64
getDestination()
String
getGraphName()
org.opendaylight.yangtools.yang.common.Uint64
getSource()
GetConstrainedPathInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> augmentationType)
GetConstrainedPathInputBuilder
setAlgorithm(AlgorithmType value)
GetConstrainedPathInputBuilder
setConstraints(Constraints value)
GetConstrainedPathInputBuilder
setDestination(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestination(Uint64)} instead.GetConstrainedPathInputBuilder
setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
GetConstrainedPathInputBuilder
setGraphName(String value)
GetConstrainedPathInputBuilder
setSource(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSource(Uint64)} instead.GetConstrainedPathInputBuilder
setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
GetConstrainedPathInputBuilder
public GetConstrainedPathInputBuilder()
-
GetConstrainedPathInputBuilder
public GetConstrainedPathInputBuilder(GetConstrainedPathInput base)
-
-
Method Detail
-
getAlgorithm
public AlgorithmType getAlgorithm()
-
getConstraints
public Constraints getConstraints()
-
getDestination
public org.opendaylight.yangtools.yang.common.Uint64 getDestination()
-
getGraphName
public String getGraphName()
-
getSource
public org.opendaylight.yangtools.yang.common.Uint64 getSource()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public GetConstrainedPathInputBuilder setAlgorithm(AlgorithmType value)
-
setConstraints
public GetConstrainedPathInputBuilder setConstraints(Constraints value)
-
setDestination
public GetConstrainedPathInputBuilder setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDestination
@Deprecated(forRemoval=true) public GetConstrainedPathInputBuilder setDestination(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestination(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setGraphName
public GetConstrainedPathInputBuilder setGraphName(String value)
-
setSource
public GetConstrainedPathInputBuilder setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setSource
@Deprecated(forRemoval=true) public GetConstrainedPathInputBuilder setSource(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSource(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public GetConstrainedPathInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput> augmentationValue)
-
removeAugmentation
public GetConstrainedPathInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetConstrainedPathInput>> augmentationType)
-
build
public GetConstrainedPathInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<GetConstrainedPathInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<GetConstrainedPathInput,IllegalArgumentException>
-
-