Class PathComputationClientBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.pcep.client.attributes.PathComputationClientBuilder
-
@Generated("mdsal-binding-generator") public class PathComputationClientBuilder extends Object
Class that buildsPathComputationClient
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:
PathComputationClient createPathComputationClient(int fooXyzzy, int barBaz) { return new PathComputationClientBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathComputationClient, 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:
PathComputationClient
- 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 PathComputationClientBuilder()
Construct an empty builder.PathComputationClientBuilder(PathComputationClient base)
Construct a builder initialized with state from specifiedPathComputationClient
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathComputationClientBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PathComputationClient
build()
A newPathComputationClient
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getIpAddress()
Return current value associated with the property corresponding toPathComputationClient.getIpAddress()
.Map<ReportedLspKey,ReportedLsp>
getReportedLsp()
Return current value associated with the property corresponding toPathComputationClient.getReportedLsp()
.StatefulTlv
getStatefulTlv()
Return current value associated with the property corresponding toPathComputationClient.getStatefulTlv()
.PccSyncState
getStateSync()
Return current value associated with the property corresponding toPathComputationClient.getStateSync()
.PathComputationClientBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> augmentationType)
Remove an augmentation from this builder's product.PathComputationClientBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toPathComputationClient.getIpAddress()
to the specified value.PathComputationClientBuilder
setReportedLsp(Map<ReportedLspKey,ReportedLsp> values)
Set the property corresponding toPathComputationClient.getReportedLsp()
to the specified value.PathComputationClientBuilder
setStatefulTlv(StatefulTlv value)
Set the property corresponding toPathComputationClient.getStatefulTlv()
to the specified value.PathComputationClientBuilder
setStateSync(PccSyncState value)
Set the property corresponding toPathComputationClient.getStateSync()
to the specified value.
-
-
-
Constructor Detail
-
PathComputationClientBuilder
public PathComputationClientBuilder()
Construct an empty builder.
-
PathComputationClientBuilder
public PathComputationClientBuilder(PathComputationClient base)
Construct a builder initialized with state from specifiedPathComputationClient
.- Parameters:
base
- PathComputationClient from which the builder should be initialized
-
-
Method Detail
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getIpAddress()
Return current value associated with the property corresponding toPathComputationClient.getIpAddress()
.- Returns:
- current value
-
getReportedLsp
public Map<ReportedLspKey,ReportedLsp> getReportedLsp()
Return current value associated with the property corresponding toPathComputationClient.getReportedLsp()
.- Returns:
- current value
-
getStateSync
public PccSyncState getStateSync()
Return current value associated with the property corresponding toPathComputationClient.getStateSync()
.- Returns:
- current value
-
getStatefulTlv
public StatefulTlv getStatefulTlv()
Return current value associated with the property corresponding toPathComputationClient.getStatefulTlv()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> 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
-
setIpAddress
public PathComputationClientBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toPathComputationClient.getIpAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReportedLsp
public PathComputationClientBuilder setReportedLsp(Map<ReportedLspKey,ReportedLsp> values)
Set the property corresponding toPathComputationClient.getReportedLsp()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setStateSync
public PathComputationClientBuilder setStateSync(PccSyncState value)
Set the property corresponding toPathComputationClient.getStateSync()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatefulTlv
public PathComputationClientBuilder setStatefulTlv(StatefulTlv value)
Set the property corresponding toPathComputationClient.getStatefulTlv()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PathComputationClientBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient> 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 PathComputationClientBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathComputationClient>> 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 PathComputationClient build()
A newPathComputationClient
instance.- Returns:
- A new
PathComputationClient
instance.
-
-