Class ConfiguredLspBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.pcc.configured.lsp.ConfiguredLspBuilder
-
@Generated("mdsal-binding-generator") public class ConfiguredLspBuilder extends Object
Class that buildsConfiguredLsp
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:
ConfiguredLsp createConfiguredLsp(int fooXyzzy, int barBaz) { return new ConfiguredLspBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConfiguredLsp, 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:
ConfiguredLsp
- 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 ConfiguredLspBuilder()
Construct an empty builder.ConfiguredLspBuilder(ConfiguredLsp base)
Construct a builder initialized with state from specifiedConfiguredLsp
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ConfiguredLspBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ConfiguredLsp
build()
A newConfiguredLsp
instance.ComputedPath
getComputedPath()
Return current value associated with the property corresponding toConfiguredLsp.getComputedPath()
.IntendedPath
getIntendedPath()
Return current value associated with the property corresponding toConfiguredLsp.getIntendedPath()
.String
getName()
Return current value associated with the property corresponding toConfiguredLsp.getName()
.PathStatus
getPathStatus()
Return current value associated with the property corresponding toConfiguredLsp.getPathStatus()
.ConfiguredLspKey
key()
Return current value associated with the property corresponding toConfiguredLsp.key()
.ConfiguredLspBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp>> augmentationType)
Remove an augmentation from this builder's product.ConfiguredLspBuilder
setComputedPath(ComputedPath value)
Set the property corresponding toConfiguredLsp.getComputedPath()
to the specified value.ConfiguredLspBuilder
setIntendedPath(IntendedPath value)
Set the property corresponding toConfiguredLsp.getIntendedPath()
to the specified value.ConfiguredLspBuilder
setName(String value)
Set the property corresponding toConfiguredLsp.getName()
to the specified value.ConfiguredLspBuilder
setPathStatus(PathStatus value)
Set the property corresponding toConfiguredLsp.getPathStatus()
to the specified value.ConfiguredLspBuilder
withKey(ConfiguredLspKey key)
-
-
-
Constructor Detail
-
ConfiguredLspBuilder
public ConfiguredLspBuilder()
Construct an empty builder.
-
ConfiguredLspBuilder
public ConfiguredLspBuilder(ConfiguredLsp base)
Construct a builder initialized with state from specifiedConfiguredLsp
.- Parameters:
base
- ConfiguredLsp from which the builder should be initialized
-
-
Method Detail
-
key
public ConfiguredLspKey key()
Return current value associated with the property corresponding toConfiguredLsp.key()
.- Returns:
- current value
-
getComputedPath
public ComputedPath getComputedPath()
Return current value associated with the property corresponding toConfiguredLsp.getComputedPath()
.- Returns:
- current value
-
getIntendedPath
public IntendedPath getIntendedPath()
Return current value associated with the property corresponding toConfiguredLsp.getIntendedPath()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toConfiguredLsp.getName()
.- Returns:
- current value
-
getPathStatus
public PathStatus getPathStatus()
Return current value associated with the property corresponding toConfiguredLsp.getPathStatus()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp>> 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
-
withKey
public ConfiguredLspBuilder withKey(ConfiguredLspKey key)
-
setComputedPath
public ConfiguredLspBuilder setComputedPath(ComputedPath value)
Set the property corresponding toConfiguredLsp.getComputedPath()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIntendedPath
public ConfiguredLspBuilder setIntendedPath(IntendedPath value)
Set the property corresponding toConfiguredLsp.getIntendedPath()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public ConfiguredLspBuilder setName(String value)
Set the property corresponding toConfiguredLsp.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathStatus
public ConfiguredLspBuilder setPathStatus(PathStatus value)
Set the property corresponding toConfiguredLsp.getPathStatus()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ConfiguredLspBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp> 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 ConfiguredLspBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ConfiguredLsp>> 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 ConfiguredLsp build()
A newConfiguredLsp
instance.- Returns:
- A new
ConfiguredLsp
instance.
-
-