jdk.dio.spibus

Class SPIDeviceConfig.Builder

java.lang.Object

jdk.dio.spibus.SPIDeviceConfig.Builder

Enclosing class:

SPIDeviceConfig

public static final class SPIDeviceConfig.Builder
extends java.lang.Object

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

   SPIDeviceConfig config = new SPIDeviceConfig.Builder()
           .setControllerNumber(1)
           .setAddress(0x8)
           .setClockFrequency(8000000)
           .setClockMode(2)
           .setWordLength(10)
           .setBitOrdering(LITTLE_ENDIAN)
           .build();
 

Since:

1.1

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
SPIDeviceConfig	build() Creates a new SPIDeviceConfig instance initialized with the values set for each configuration parameters.
SPIDeviceConfig.Builder	setAddress(int address) Sets the Chip Select address of the slave device on the bus.
SPIDeviceConfig.Builder	setBitOrdering(int bitOrdering) Sets the bit (shifting) ordering of the slave device (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setClockFrequency(int clockFrequency) Sets the clock frequency of the slave device in Hz (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setClockMode(int clockMode) Sets the clock mode (default value is 0 if not set).
SPIDeviceConfig.Builder	setControllerName(java.lang.String controllerName) Sets the name of the bus the slave device is connected to (default value is null if not set).
SPIDeviceConfig.Builder	setControllerNumber(int controllerNumber) Sets the number of the bus the slave device is connected to (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setCSActiveLevel(int csActive) Sets the Chip Select active level (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setInputBufferSize(int inputBufferSize) Sets the requested input buffer size (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setOutputBufferSize(int outputBufferSize) Sets the requested output buffer size (default value is UNASSIGNED if not set).
SPIDeviceConfig.Builder	setWordLength(int wordLength) Sets the word length of the slave device (default value is UNASSIGNED if not set).

Methods inherited from class java.lang.Object

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

Constructor Detail

SPIDeviceConfig.Builder

public SPIDeviceConfig.Builder()

Creates a new Builder instance.

Method Detail

build

public SPIDeviceConfig build()

Creates a new SPIDeviceConfig 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 SPIDeviceConfig instance.

Throws:

java.lang.IllegalStateException - if any of the following is true:

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

setControllerName

public SPIDeviceConfig.Builder setControllerName(java.lang.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 SPIDeviceConfig.Builder setAddress(int address)

Sets the Chip Select address of the slave device on the bus.

Parameters:

address - the Chip Select address of the slave device on the bus (a positive or zero integer).

Returns:

this Builder instance.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• address is not in the defined range;

setControllerNumber

public SPIDeviceConfig.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:

java.lang.IllegalArgumentException - if controllerNumber is not in the defined range.

setInputBufferSize

public SPIDeviceConfig.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:

java.lang.IllegalArgumentException - if inputBufferSize is not in the defined range.

setOutputBufferSize

public SPIDeviceConfig.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:

java.lang.IllegalArgumentException - if outputBufferSize is not in the defined range.

setCSActiveLevel

public SPIDeviceConfig.Builder setCSActiveLevel(int csActive)

Sets the Chip Select active level (default value is UNASSIGNED if not set).

Parameters:

csActive - the Chip Select active level, one of SPIDeviceConfig.CS_ACTIVE_LOW, SPIDeviceConfig.CS_ACTIVE_HIGH, SPIDeviceConfig.CS_NOT_CONTROLLED or UNASSIGNED.

Returns:

this Builder instance.

Throws:

java.lang.IllegalArgumentException - if csActive is not in the defined range.

setBitOrdering

public SPIDeviceConfig.Builder setBitOrdering(int bitOrdering)

Sets the bit (shifting) ordering of the slave device (default value is UNASSIGNED if not set).

Parameters:

bitOrdering - the bit (shifting) ordering of the slave device, one of: Device.BIG_ENDIAN, Device.LITTLE_ENDIAN, Device.MIXED_ENDIAN or UNASSIGNED.

Returns:

this Builder instance.

Throws:

java.lang.IllegalArgumentException - if bitOrdering is not in the defined range.

setClockMode

public SPIDeviceConfig.Builder setClockMode(int clockMode)

Sets the clock mode (default value is 0 if not set).

Parameters:

clockMode - the clock mode, one of: 0, 1, 2 or 3 (see SPI Clock Modes).

Returns:

this Builder instance.

Throws:

java.lang.IllegalArgumentException - if clockMode is not in the defined range.

setWordLength

public SPIDeviceConfig.Builder setWordLength(int wordLength)

Sets the word length of the slave device (default value is UNASSIGNED if not set).

Parameters:

wordLength - the word length of the slave device (a positive integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

java.lang.IllegalArgumentException - if wordLength is not in the defined range.

setClockFrequency

public SPIDeviceConfig.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:

java.lang.IllegalArgumentException - if clockFrequency is not in the defined range.