Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.config.rev200120.pcep.config
Class SessionConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.config.rev200120.pcep.config.SessionConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SessionConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SessionConfig,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SessionConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SessionConfig>
Class that buildsSessionConfigBuilder
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:
SessionConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new SessionConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SessionConfigBuilder, 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:
SessionConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SessionConfigBuilder()
SessionConfigBuilder(SessionConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SessionConfigBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>>
E$$augmentation(Class<E$$> augmentationType)
SessionConfig
build()
org.opendaylight.yangtools.yang.common.Uint16
getDeadTimerValue()
org.opendaylight.yangtools.yang.common.Uint16
getKeepAliveTimerValue()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getListenAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getListenPort()
Short
getRpcTimeout()
SessionConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType)
SessionConfigBuilder
setDeadTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDeadTimerValue(Uint16)} instead.SessionConfigBuilder
setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
SessionConfigBuilder
setKeepAliveTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setKeepAliveTimerValue(Uint16)} instead.SessionConfigBuilder
setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
SessionConfigBuilder
setListenAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
SessionConfigBuilder
setListenPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
SessionConfigBuilder
setRpcTimeout(Short value)
-
-
-
Constructor Detail
-
SessionConfigBuilder
public SessionConfigBuilder()
-
SessionConfigBuilder
public SessionConfigBuilder(SessionConfig base)
-
-
Method Detail
-
getDeadTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getDeadTimerValue()
-
getKeepAliveTimerValue
public org.opendaylight.yangtools.yang.common.Uint16 getKeepAliveTimerValue()
-
getListenAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getListenAddress()
-
getListenPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getListenPort()
-
getRpcTimeout
public Short getRpcTimeout()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> E$$ augmentation(Class<E$$> augmentationType)
-
setDeadTimerValue
public SessionConfigBuilder setDeadTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDeadTimerValue
@Deprecated(forRemoval=true) public SessionConfigBuilder setDeadTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDeadTimerValue(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setKeepAliveTimerValue
public SessionConfigBuilder setKeepAliveTimerValue(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setKeepAliveTimerValue
@Deprecated(forRemoval=true) public SessionConfigBuilder setKeepAliveTimerValue(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setKeepAliveTimerValue(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setListenAddress
public SessionConfigBuilder setListenAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setListenPort
public SessionConfigBuilder setListenPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setRpcTimeout
public SessionConfigBuilder setRpcTimeout(Short value)
-
addAugmentation
public SessionConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig> augmentationValue)
-
removeAugmentation
public SessionConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SessionConfig>> augmentationType)
-
build
public SessionConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SessionConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SessionConfig,IllegalArgumentException>
-
-