Class PcepSessionConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.app.config.rev160707.PcepSessionConfigBuilder
Class that builds
PcepSessionConfig
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedPcepSessionConfig
.Construct a new builder initialized from specifiedPcepSessionTimers
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.static @NonNull PcepSessionConfig
empty()
Get empty instance of PcepSessionConfig.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPcepSessionTimers.getDeadTimerValue()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPcepSessionTimers.getKeepAliveTimerValue()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepSessionConfig>> augmentationType) Remove an augmentation from this builder's product.setDeadTimerValue
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPcepSessionTimers.getDeadTimerValue()
to the specified value.setKeepAliveTimerValue
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPcepSessionTimers.getKeepAliveTimerValue()
to the specified value.
-
Constructor Details
-
PcepSessionConfigBuilder
public PcepSessionConfigBuilder()Construct an empty builder. -
PcepSessionConfigBuilder
Construct a new builder initialized from specifiedPcepSessionTimers
.- Parameters:
arg
- PcepSessionTimers from which the builder should be initialized
-
PcepSessionConfigBuilder
Construct a builder initialized with state from specifiedPcepSessionConfig
.- Parameters:
base
- PcepSessionConfig from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of PcepSessionConfig.- Returns:
- An empty
PcepSessionConfig
-
getDeadTimerValue
public org.opendaylight.yangtools.yang.common.Uint8 getDeadTimerValue()Return current value associated with the property corresponding toPcepSessionTimers.getDeadTimerValue()
.- Returns:
- current value
-
getKeepAliveTimerValue
public org.opendaylight.yangtools.yang.common.Uint8 getKeepAliveTimerValue()Return current value associated with the property corresponding toPcepSessionTimers.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.Uint8 value) Set the property corresponding toPcepSessionTimers.getDeadTimerValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setKeepAliveTimerValue
public PcepSessionConfigBuilder setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPcepSessionTimers.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
A newPcepSessionConfig
instance.- Returns:
- A new
PcepSessionConfig
instance.
-