org.joshvm.j2me.dio.i2cbus

Class I2CDeviceConfig.Builder

java.lang.Object

org.joshvm.j2me.dio.i2cbus.I2CDeviceConfig.Builder

Enclosing class:

I2CDeviceConfig

public static final class I2CDeviceConfig.Builder
extends Object

The Builder class allows for creating and initializing I2CDeviceConfig objects. Calls can be chained in the following manner:

   I2CDeviceConfig config = new I2CDeviceConfig.Builder()
           .setControllerNumber(1)
           .setAddress(0x300, ADDR_SIZE_10)
           .setClockFrequency(8000000)
           .build();
 

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
I2CDeviceConfig.Builder() Creates a new Builder instance.

Method Summary

Methods

Modifier and Type	Method and Description
I2CDeviceConfig	build() Creates a new I2CDeviceConfig instance initialized with the values set for each configuration parameters.
I2CDeviceConfig.Builder	setAddress(int address, int addressSize) Sets the address of the slave device on the bus.
I2CDeviceConfig.Builder	setClockFrequency(int clockFrequency) Sets the clock frequency of the slave device in Hz (default value is UNASSIGNED if not set).
I2CDeviceConfig.Builder	setControllerName(String controllerName) Sets the name of the bus the slave device is connected to (default value is null if not set).
I2CDeviceConfig.Builder	setControllerNumber(int controllerNumber) Sets the number of the bus the slave device is connected to (default value is UNASSIGNED if not set).
I2CDeviceConfig.Builder	setInputBufferSize(int inputBufferSize) Sets the requested input buffer size (default value is UNASSIGNED if not set).
I2CDeviceConfig.Builder	setOutputBufferSize(int outputBufferSize) Sets the requested output buffer size (default value is UNASSIGNED if not set).

Methods inherited from class java.lang.Object

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

Constructor Detail

I2CDeviceConfig.Builder

public I2CDeviceConfig.Builder()

Creates a new Builder instance.

Method Detail

build

public I2CDeviceConfig build()

Creates a new I2CDeviceConfig instance initialized with the values set for each configuration parameters. If a configuration parameter was not explictly set its default value will be used.

Returns:

a new initialized I2CDeviceConfig instance.

Throws:

IllegalStateException - if any of the following is true:

• the address of the slave device on the bus is not set.

setControllerName

public I2CDeviceConfig.Builder setControllerName(String controllerName)

Sets the name of the bus the slave device is connected to (default value is null if not set).

Parameters:

controllerName - the name of the bus the slave device is connected to (such as its device file name on UNIX systems) or null.

Returns:

this Builder instance.

setAddress

public I2CDeviceConfig.Builder setAddress(int address,
                                 int addressSize)

Sets the address of the slave device on the bus.

Parameters:

address - the address of the slave device on the bus (a positive or zero integer, strictly lesser than 2^addressSize).

addressSize - the address size: I2CDeviceConfig.ADDR_SIZE_7 bits, I2CDeviceConfig.ADDR_SIZE_10 bits.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if any of the following is true:

• address is not in the defined range;
• addressSize is not in the defined range;

setControllerNumber

public I2CDeviceConfig.Builder setControllerNumber(int controllerNumber)

Sets the number of the bus the slave device is connected to (default value is UNASSIGNED if not set).

Parameters:

controllerNumber - the number of the bus the slave device is connected to (a positive or zero integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if controllerNumber is not in the defined range.

setInputBufferSize

public I2CDeviceConfig.Builder setInputBufferSize(int inputBufferSize)

Sets the requested input buffer size (default value is UNASSIGNED if not set).

Parameters:

inputBufferSize - the requested input buffer size in number of samples (a positive or zero integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if inputBufferSize is not in the defined range.

setOutputBufferSize

public I2CDeviceConfig.Builder setOutputBufferSize(int outputBufferSize)

Sets the requested output buffer size (default value is UNASSIGNED if not set).

Parameters:

outputBufferSize - the requested output buffer size in number of samples (a positive or zero integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if outputBufferSize is not in the defined range.

setClockFrequency

public I2CDeviceConfig.Builder setClockFrequency(int clockFrequency)

Sets the clock frequency of the slave device in Hz (default value is UNASSIGNED if not set).

Parameters:

clockFrequency - the clock frequency of the slave device in Hz (a positive integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

IllegalArgumentException - if clockFrequency is not in the defined range.