Class PcepSessionConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.app.config.rev160707.PcepSessionConfigBuilder
-
@Generated("mdsal-binding-generator") public class PcepSessionConfigBuilder extends Object
Class that buildsPcepSessionConfig
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:
PcepSessionConfig createPcepSessionConfig(int fooXyzzy, int barBaz) { return new PcepSessionConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepSessionConfig, 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:
PcepSessionConfig
- 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 PcepSessionConfigBuilder()
Construct an empty builder.PcepSessionConfigBuilder(PcepSessionConfig base)
Construct a builder initialized with state from specifiedPcepSessionConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepSessionConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcepSessionConfig
build()
A newPcepSessionConfig
instance.org.opendaylight.yangtools.yang.common.Uint16
getDeadTimerValue()
Return current value associated with the property corresponding toPcepSessionConfig.getDeadTimerValue()
.org.opendaylight.yangtools.yang.common.Uint16
getKeepAliveTimerValue()
Return current value associated with the property corresponding toPcepSessionConfig.getKeepAliveTimerValue()
.PcepSessionConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> augmentationType)
Remove an augmentation from this builder's product.PcepSessionConfigBuilder
setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepSessionConfig.getDeadTimerValue()
to the specified value.PcepSessionConfigBuilder
setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepSessionConfig.getKeepAliveTimerValue()
to the specified value.
-
-
-
Constructor Detail
-
PcepSessionConfigBuilder
public PcepSessionConfigBuilder()
Construct an empty builder.
-
PcepSessionConfigBuilder
public PcepSessionConfigBuilder(PcepSessionConfig base)
Construct a builder initialized with state from specifiedPcepSessionConfig
.- Parameters:
base
- PcepSessionConfig from which the builder should be initialized
-
-
Method Detail
-
getDeadTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getDeadTimerValue()
Return current value associated with the property corresponding toPcepSessionConfig.getDeadTimerValue()
.- Returns:
- current value
-
getKeepAliveTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getKeepAliveTimerValue()
Return current value associated with the property corresponding toPcepSessionConfig.getKeepAliveTimerValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> 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
-
setDeadTimerValue
public PcepSessionConfigBuilder setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepSessionConfig.getDeadTimerValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setKeepAliveTimerValue
public PcepSessionConfigBuilder setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepSessionConfig.getKeepAliveTimerValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepSessionConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig> 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 PcepSessionConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> 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 PcepSessionConfig build()
A newPcepSessionConfig
instance.- Returns:
- A new
PcepSessionConfig
instance.
-
-