Class SwitchConnectionConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflow._switch.connection.config.rev160506.SwitchConnectionConfigBuilder
-
@Generated("mdsal-binding-generator") public class SwitchConnectionConfigBuilder extends Object
Class that buildsSwitchConnectionConfig
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:
SwitchConnectionConfig createSwitchConnectionConfig(int fooXyzzy, int barBaz) { return new SwitchConnectionConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SwitchConnectionConfig, 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:
SwitchConnectionConfig
- 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 SwitchConnectionConfigBuilder()
Construct an empty builder.SwitchConnectionConfigBuilder(SwitchConnectionConfig base)
Construct a builder initialized with state from specifiedSwitchConnectionConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SwitchConnectionConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SwitchConnectionConfig
build()
A newSwitchConnectionConfig
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getAddress()
Return current value associated with the property corresponding toSwitchConnectionConfig.getAddress()
.org.opendaylight.yangtools.yang.common.Uint16
getChannelOutboundQueueSize()
Return current value associated with the property corresponding toSwitchConnectionConfig.getChannelOutboundQueueSize()
.Boolean
getGroupAddModEnabled()
Return current value associated with the property corresponding toSwitchConnectionConfig.getGroupAddModEnabled()
.String
getInstanceName()
Return current value associated with the property corresponding toSwitchConnectionConfig.getInstanceName()
.org.opendaylight.yangtools.yang.common.Uint16
getPort()
Return current value associated with the property corresponding toSwitchConnectionConfig.getPort()
.org.opendaylight.yangtools.yang.common.Uint32
getSwitchIdleTimeout()
Return current value associated with the property corresponding toSwitchConnectionConfig.getSwitchIdleTimeout()
.Threads
getThreads()
Return current value associated with the property corresponding toSwitchConnectionConfig.getThreads()
.Tls
getTls()
Return current value associated with the property corresponding toSwitchConnectionConfig.getTls()
.TransportProtocol
getTransportProtocol()
Return current value associated with the property corresponding toSwitchConnectionConfig.getTransportProtocol()
.Boolean
getUseBarrier()
Return current value associated with the property corresponding toSwitchConnectionConfig.getUseBarrier()
.SwitchConnectionConfigKey
key()
Return current value associated with the property corresponding toSwitchConnectionConfig.key()
.SwitchConnectionConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig>> augmentationType)
Remove an augmentation from this builder's product.SwitchConnectionConfigBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toSwitchConnectionConfig.getAddress()
to the specified value.SwitchConnectionConfigBuilder
setChannelOutboundQueueSize(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSwitchConnectionConfig.getChannelOutboundQueueSize()
to the specified value.SwitchConnectionConfigBuilder
setGroupAddModEnabled(Boolean value)
Set the property corresponding toSwitchConnectionConfig.getGroupAddModEnabled()
to the specified value.SwitchConnectionConfigBuilder
setInstanceName(String value)
Set the property corresponding toSwitchConnectionConfig.getInstanceName()
to the specified value.SwitchConnectionConfigBuilder
setPort(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSwitchConnectionConfig.getPort()
to the specified value.SwitchConnectionConfigBuilder
setSwitchIdleTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSwitchConnectionConfig.getSwitchIdleTimeout()
to the specified value.SwitchConnectionConfigBuilder
setThreads(Threads value)
Set the property corresponding toSwitchConnectionConfig.getThreads()
to the specified value.SwitchConnectionConfigBuilder
setTls(Tls value)
Set the property corresponding toSwitchConnectionConfig.getTls()
to the specified value.SwitchConnectionConfigBuilder
setTransportProtocol(TransportProtocol value)
Set the property corresponding toSwitchConnectionConfig.getTransportProtocol()
to the specified value.SwitchConnectionConfigBuilder
setUseBarrier(Boolean value)
Set the property corresponding toSwitchConnectionConfig.getUseBarrier()
to the specified value.SwitchConnectionConfigBuilder
withKey(SwitchConnectionConfigKey key)
-
-
-
Constructor Detail
-
SwitchConnectionConfigBuilder
public SwitchConnectionConfigBuilder()
Construct an empty builder.
-
SwitchConnectionConfigBuilder
public SwitchConnectionConfigBuilder(SwitchConnectionConfig base)
Construct a builder initialized with state from specifiedSwitchConnectionConfig
.- Parameters:
base
- SwitchConnectionConfig from which the builder should be initialized
-
-
Method Detail
-
key
public SwitchConnectionConfigKey key()
Return current value associated with the property corresponding toSwitchConnectionConfig.key()
.- Returns:
- current value
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAddress()
Return current value associated with the property corresponding toSwitchConnectionConfig.getAddress()
.- Returns:
- current value
-
getChannelOutboundQueueSize
public org.opendaylight.yangtools.yang.common.Uint16 getChannelOutboundQueueSize()
Return current value associated with the property corresponding toSwitchConnectionConfig.getChannelOutboundQueueSize()
.- Returns:
- current value
-
getGroupAddModEnabled
public Boolean getGroupAddModEnabled()
Return current value associated with the property corresponding toSwitchConnectionConfig.getGroupAddModEnabled()
.- Returns:
- current value
-
getInstanceName
public String getInstanceName()
Return current value associated with the property corresponding toSwitchConnectionConfig.getInstanceName()
.- Returns:
- current value
-
getPort
public org.opendaylight.yangtools.yang.common.Uint16 getPort()
Return current value associated with the property corresponding toSwitchConnectionConfig.getPort()
.- Returns:
- current value
-
getSwitchIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint32 getSwitchIdleTimeout()
Return current value associated with the property corresponding toSwitchConnectionConfig.getSwitchIdleTimeout()
.- Returns:
- current value
-
getThreads
public Threads getThreads()
Return current value associated with the property corresponding toSwitchConnectionConfig.getThreads()
.- Returns:
- current value
-
getTls
public Tls getTls()
Return current value associated with the property corresponding toSwitchConnectionConfig.getTls()
.- Returns:
- current value
-
getTransportProtocol
public TransportProtocol getTransportProtocol()
Return current value associated with the property corresponding toSwitchConnectionConfig.getTransportProtocol()
.- Returns:
- current value
-
getUseBarrier
public Boolean getUseBarrier()
Return current value associated with the property corresponding toSwitchConnectionConfig.getUseBarrier()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig>> 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
-
withKey
public SwitchConnectionConfigBuilder withKey(SwitchConnectionConfigKey key)
-
setAddress
public SwitchConnectionConfigBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toSwitchConnectionConfig.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setChannelOutboundQueueSize
public SwitchConnectionConfigBuilder setChannelOutboundQueueSize(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSwitchConnectionConfig.getChannelOutboundQueueSize()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setGroupAddModEnabled
public SwitchConnectionConfigBuilder setGroupAddModEnabled(Boolean value)
Set the property corresponding toSwitchConnectionConfig.getGroupAddModEnabled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstanceName
public SwitchConnectionConfigBuilder setInstanceName(String value)
Set the property corresponding toSwitchConnectionConfig.getInstanceName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public SwitchConnectionConfigBuilder setPort(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSwitchConnectionConfig.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSwitchIdleTimeout
public SwitchConnectionConfigBuilder setSwitchIdleTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSwitchConnectionConfig.getSwitchIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setThreads
public SwitchConnectionConfigBuilder setThreads(Threads value)
Set the property corresponding toSwitchConnectionConfig.getThreads()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTls
public SwitchConnectionConfigBuilder setTls(Tls value)
Set the property corresponding toSwitchConnectionConfig.getTls()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransportProtocol
public SwitchConnectionConfigBuilder setTransportProtocol(TransportProtocol value)
Set the property corresponding toSwitchConnectionConfig.getTransportProtocol()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUseBarrier
public SwitchConnectionConfigBuilder setUseBarrier(Boolean value)
Set the property corresponding toSwitchConnectionConfig.getUseBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SwitchConnectionConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig> 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 SwitchConnectionConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchConnectionConfig>> 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 SwitchConnectionConfig build()
A newSwitchConnectionConfig
instance.- Returns:
- A new
SwitchConnectionConfig
instance.
-
-