org.eclipse.kura.comm

Class CommURI.Builder

java.lang.Object

org.eclipse.kura.comm.CommURI.Builder

Enclosing class:

CommURI

@ProviderType
public static class CommURI.Builder
extends java.lang.Object

Builder class used as a helper in building the components of a CommURI.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String port)

Method Summary

Modifier and Type	Method and Description
CommURI	build()
CommURI.Builder	withBaudRate(int baudRate)
CommURI.Builder	withDataBits(int dataBits)
CommURI.Builder	withFlowControl(int flowControl)
CommURI.Builder	withOpenTimeout(int timeout) Sets the open timeout associated with the port
CommURI.Builder	withParity(int parity)
CommURI.Builder	withReceiveTimeout(int timeout) Sets the receive timeout associated with the port.
CommURI.Builder	withStopBits(int stopBits)
CommURI.Builder	withTimeout(int timeout) Deprecated. use withOpenTimeout(int) and withReceiveTimeout(int) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String port)

Method Detail

withBaudRate

public CommURI.Builder withBaudRate(int baudRate)

withDataBits

public CommURI.Builder withDataBits(int dataBits)

withStopBits

public CommURI.Builder withStopBits(int stopBits)

withParity

public CommURI.Builder withParity(int parity)

withFlowControl

public CommURI.Builder withFlowControl(int flowControl)

withTimeout

@Deprecated
public CommURI.Builder withTimeout(int timeout)

Deprecated. use withOpenTimeout(int) and withReceiveTimeout(int) instead

Sets the open timeout associated with the port, this method is identical to withOpenTimeout(int)

Parameters:

timeout - The open timeout in milliseconds.

Returns:

Since:

1.1.0

withOpenTimeout

public CommURI.Builder withOpenTimeout(int timeout)

Sets the open timeout associated with the port

Parameters:

timeout - The open timeout in milliseconds.

Returns:

Since:

1.2

withReceiveTimeout

public CommURI.Builder withReceiveTimeout(int timeout)

Sets the receive timeout associated with the port. Pass 0 to disable the receive timeout. The receive timeout is disabled by default.

Parameters:

timeout - The receive timeout in milliseconds.

Returns:

Since:

1.2

build

public CommURI build()