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