org.openmuc.jmbus.transportlayer

Class Builder<C,B extends Builder<C,B>>

java.lang.Object

org.openmuc.jmbus.transportlayer.Builder<C,B>

Type Parameters:

C - the resulting connection after calling build().

B - the inheriting builder type.

Direct Known Subclasses:

SerialBuilder, TcpBuilder

public abstract class Builder<C,B extends Builder<C,B>>
extends java.lang.Object

A abstract builder to an active M-Bus connection.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
abstract C	build() This return an active M-Bus connection.
protected abstract TransportLayer	buildTransportLayer() Build the TransportLayer with the given settings.
protected B	self()
B	setTimeout(int timeout) Set the connection timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder()

Method Detail

setTimeout

public B setTimeout(int timeout)

Set the connection timeout. The timeout must be ≥ zero. A timeout of zero is interpreted as infinite timeout,

Parameters:

timeout - a timeout in milliseconds.

Returns:

the builder itself.

self

protected B self()

buildTransportLayer

protected abstract TransportLayer buildTransportLayer()
                                               throws java.io.IOException

Build the TransportLayer with the given settings.

Returns:

TransportLayer to connect to the M-Bus device

Throws:

java.io.IOException - if an I/O exception occurred.

build

public abstract C build()
                 throws java.io.IOException

This return an active M-Bus connection.

Returns:

a new active M-Bus connection.

Throws:

java.io.IOException - if an I/O exception occurred opening the connection to the remote device.