Class PcepSessionConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.app.config.rev160707.PcepSessionConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcepSessionConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcepSessionConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PcepSessionConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcepSessionConfig>
Class that buildsPcepSessionConfigBuilder
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:
PcepSessionConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new PcepSessionConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepSessionConfigBuilder, 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:
PcepSessionConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PcepSessionConfigBuilder()
PcepSessionConfigBuilder(PcepSessionConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
PcepSessionConfig
build()
org.opendaylight.yangtools.yang.common.Uint16
getDeadTimerValue()
org.opendaylight.yangtools.yang.common.Uint16
getKeepAliveTimerValue()
PcepSessionConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> augmentationType)
Remove an augmentation from this builder's product.PcepSessionConfigBuilder
setDeadTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDeadTimerValue(Uint16)
instead.PcepSessionConfigBuilder
setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
PcepSessionConfigBuilder
setKeepAliveTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetKeepAliveTimerValue(Uint16)
instead.PcepSessionConfigBuilder
setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
PcepSessionConfigBuilder
public PcepSessionConfigBuilder()
-
PcepSessionConfigBuilder
public PcepSessionConfigBuilder(PcepSessionConfig base)
-
-
Method Detail
-
getDeadTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getDeadTimerValue()
-
getKeepAliveTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getKeepAliveTimerValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setDeadTimerValue
public PcepSessionConfigBuilder setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDeadTimerValue
@Deprecated(forRemoval=true) public PcepSessionConfigBuilder setDeadTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDeadTimerValue(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setKeepAliveTimerValue
public PcepSessionConfigBuilder setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setKeepAliveTimerValue
@Deprecated(forRemoval=true) public PcepSessionConfigBuilder setKeepAliveTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetKeepAliveTimerValue(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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 PcepSessionConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcepSessionConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcepSessionConfig,IllegalArgumentException>
-
-