Class ConstrainedPathBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.ConstrainedPathBuilder
-
@Generated("mdsal-binding-generator") public class ConstrainedPathBuilder extends Object
Class that buildsConstrainedPath
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:
ConstrainedPath createConstrainedPath(int fooXyzzy, int barBaz) { return new ConstrainedPathBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConstrainedPath, 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:
ConstrainedPath
- 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 ConstrainedPathBuilder()
Construct an empty builder.ConstrainedPathBuilder(ConstrainedPath base)
Construct a builder initialized with state from specifiedConstrainedPath
.ConstrainedPathBuilder(PathConstraints arg)
Construct a new builder initialized from specifiedPathConstraints
.ConstrainedPathBuilder(PathDescriptions arg)
Construct a new builder initialized from specifiedPathDescriptions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConstrainedPathBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ConstrainedPath
build()
A newConstrainedPath
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AddressFamily
getAddressFamily()
Return current value associated with the property corresponding toPathConstraints.getAddressFamily()
.org.opendaylight.yangtools.yang.common.Uint32
getAdminGroup()
Return current value associated with the property corresponding toPathConstraints.getAdminGroup()
.DecimalBandwidth
getBandwidth()
Return current value associated with the property corresponding toPathConstraints.getBandwidth()
.org.opendaylight.yangtools.yang.common.Uint8
getClassType()
Return current value associated with the property corresponding toPathConstraints.getClassType()
.Delay
getDelay()
Return current value associated with the property corresponding toPathConstraints.getDelay()
.org.opendaylight.yangtools.yang.common.Uint64
getDestination()
Return current value associated with the property corresponding toConstrainedPath.getDestination()
.List<ExcludeRoute>
getExcludeRoute()
Return current value associated with the property corresponding toPathConstraints.getExcludeRoute()
.List<IncludeRoute>
getIncludeRoute()
Return current value associated with the property corresponding toPathConstraints.getIncludeRoute()
.Delay
getJitter()
Return current value associated with the property corresponding toPathConstraints.getJitter()
.Loss
getLoss()
Return current value associated with the property corresponding toPathConstraints.getLoss()
.org.opendaylight.yangtools.yang.common.Uint32
getMetric()
Return current value associated with the property corresponding toPathConstraints.getMetric()
.List<PathDescription>
getPathDescription()
Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.org.opendaylight.yangtools.yang.common.Uint64
getSource()
Return current value associated with the property corresponding toConstrainedPath.getSource()
.ComputationStatus
getStatus()
Return current value associated with the property corresponding toConstrainedPath.getStatus()
.org.opendaylight.yangtools.yang.common.Uint32
getTeMetric()
Return current value associated with the property corresponding toPathConstraints.getTeMetric()
.ConstrainedPathBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath>> augmentationType)
Remove an augmentation from this builder's product.ConstrainedPathBuilder
setAddressFamily(AddressFamily value)
Set the property corresponding toPathConstraints.getAddressFamily()
to the specified value.ConstrainedPathBuilder
setAdminGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getAdminGroup()
to the specified value.ConstrainedPathBuilder
setBandwidth(DecimalBandwidth value)
Set the property corresponding toPathConstraints.getBandwidth()
to the specified value.ConstrainedPathBuilder
setClassType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPathConstraints.getClassType()
to the specified value.ConstrainedPathBuilder
setDelay(Delay value)
Set the property corresponding toPathConstraints.getDelay()
to the specified value.ConstrainedPathBuilder
setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toConstrainedPath.getDestination()
to the specified value.ConstrainedPathBuilder
setExcludeRoute(List<ExcludeRoute> values)
Set the property corresponding toPathConstraints.getExcludeRoute()
to the specified value.ConstrainedPathBuilder
setIncludeRoute(List<IncludeRoute> values)
Set the property corresponding toPathConstraints.getIncludeRoute()
to the specified value.ConstrainedPathBuilder
setJitter(Delay value)
Set the property corresponding toPathConstraints.getJitter()
to the specified value.ConstrainedPathBuilder
setLoss(Loss value)
Set the property corresponding toPathConstraints.getLoss()
to the specified value.ConstrainedPathBuilder
setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getMetric()
to the specified value.ConstrainedPathBuilder
setPathDescription(List<PathDescription> values)
Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.ConstrainedPathBuilder
setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toConstrainedPath.getSource()
to the specified value.ConstrainedPathBuilder
setStatus(ComputationStatus value)
Set the property corresponding toConstrainedPath.getStatus()
to the specified value.ConstrainedPathBuilder
setTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getTeMetric()
to the specified value.
-
-
-
Constructor Detail
-
ConstrainedPathBuilder
public ConstrainedPathBuilder()
Construct an empty builder.
-
ConstrainedPathBuilder
public ConstrainedPathBuilder(PathConstraints arg)
Construct a new builder initialized from specifiedPathConstraints
.- Parameters:
arg
- PathConstraints from which the builder should be initialized
-
ConstrainedPathBuilder
public ConstrainedPathBuilder(PathDescriptions arg)
Construct a new builder initialized from specifiedPathDescriptions
.- Parameters:
arg
- PathDescriptions from which the builder should be initialized
-
ConstrainedPathBuilder
public ConstrainedPathBuilder(ConstrainedPath base)
Construct a builder initialized with state from specifiedConstrainedPath
.- Parameters:
base
- ConstrainedPath 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
-
getAddressFamily
public AddressFamily getAddressFamily()
Return current value associated with the property corresponding toPathConstraints.getAddressFamily()
.- Returns:
- current value
-
getAdminGroup
public org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()
Return current value associated with the property corresponding toPathConstraints.getAdminGroup()
.- Returns:
- current value
-
getBandwidth
public DecimalBandwidth getBandwidth()
Return current value associated with the property corresponding toPathConstraints.getBandwidth()
.- Returns:
- current value
-
getClassType
public org.opendaylight.yangtools.yang.common.Uint8 getClassType()
Return current value associated with the property corresponding toPathConstraints.getClassType()
.- Returns:
- current value
-
getDelay
public Delay getDelay()
Return current value associated with the property corresponding toPathConstraints.getDelay()
.- Returns:
- current value
-
getDestination
public org.opendaylight.yangtools.yang.common.Uint64 getDestination()
Return current value associated with the property corresponding toConstrainedPath.getDestination()
.- Returns:
- current value
-
getExcludeRoute
public List<ExcludeRoute> getExcludeRoute()
Return current value associated with the property corresponding toPathConstraints.getExcludeRoute()
.- Returns:
- current value
-
getIncludeRoute
public List<IncludeRoute> getIncludeRoute()
Return current value associated with the property corresponding toPathConstraints.getIncludeRoute()
.- Returns:
- current value
-
getJitter
public Delay getJitter()
Return current value associated with the property corresponding toPathConstraints.getJitter()
.- Returns:
- current value
-
getLoss
public Loss getLoss()
Return current value associated with the property corresponding toPathConstraints.getLoss()
.- Returns:
- current value
-
getMetric
public org.opendaylight.yangtools.yang.common.Uint32 getMetric()
Return current value associated with the property corresponding toPathConstraints.getMetric()
.- Returns:
- current value
-
getPathDescription
public List<PathDescription> getPathDescription()
Return current value associated with the property corresponding toPathDescriptions.getPathDescription()
.- Returns:
- current value
-
getSource
public org.opendaylight.yangtools.yang.common.Uint64 getSource()
Return current value associated with the property corresponding toConstrainedPath.getSource()
.- Returns:
- current value
-
getStatus
public ComputationStatus getStatus()
Return current value associated with the property corresponding toConstrainedPath.getStatus()
.- Returns:
- current value
-
getTeMetric
public org.opendaylight.yangtools.yang.common.Uint32 getTeMetric()
Return current value associated with the property corresponding toPathConstraints.getTeMetric()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath>> 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
-
setAddressFamily
public ConstrainedPathBuilder setAddressFamily(AddressFamily value)
Set the property corresponding toPathConstraints.getAddressFamily()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAdminGroup
public ConstrainedPathBuilder setAdminGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getAdminGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBandwidth
public ConstrainedPathBuilder setBandwidth(DecimalBandwidth value)
Set the property corresponding toPathConstraints.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setClassType
public ConstrainedPathBuilder setClassType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPathConstraints.getClassType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDelay
public ConstrainedPathBuilder setDelay(Delay value)
Set the property corresponding toPathConstraints.getDelay()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDestination
public ConstrainedPathBuilder setDestination(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toConstrainedPath.getDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExcludeRoute
public ConstrainedPathBuilder setExcludeRoute(List<ExcludeRoute> values)
Set the property corresponding toPathConstraints.getExcludeRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setIncludeRoute
public ConstrainedPathBuilder setIncludeRoute(List<IncludeRoute> values)
Set the property corresponding toPathConstraints.getIncludeRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setJitter
public ConstrainedPathBuilder setJitter(Delay value)
Set the property corresponding toPathConstraints.getJitter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLoss
public ConstrainedPathBuilder setLoss(Loss value)
Set the property corresponding toPathConstraints.getLoss()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetric
public ConstrainedPathBuilder setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathDescription
public ConstrainedPathBuilder setPathDescription(List<PathDescription> values)
Set the property corresponding toPathDescriptions.getPathDescription()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSource
public ConstrainedPathBuilder setSource(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toConstrainedPath.getSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatus
public ConstrainedPathBuilder setStatus(ComputationStatus value)
Set the property corresponding toConstrainedPath.getStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTeMetric
public ConstrainedPathBuilder setTeMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPathConstraints.getTeMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ConstrainedPathBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath> 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 ConstrainedPathBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConstrainedPath>> 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 ConstrainedPath build()
A newConstrainedPath
instance.- Returns:
- A new
ConstrainedPath
instance.
-
-