jdk.dio.generic

Class GenericDeviceConfig.Builder

java.lang.Object

jdk.dio.generic.GenericDeviceConfig.Builder

Enclosing class:

GenericDeviceConfig

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

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

   GenericDeviceConfig config = new GenericDeviceConfig.Builder()
           .setControllerNumber(1)
           .setChannelNumber(1)
           .setInputBufferSize(0)
           .setOutputBufferSize(0)
           .build();
 

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
GenericDeviceConfig.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
GenericDeviceConfig	build() Creates a new GenericDeviceConfig instance initialized with the values set for each configuration parameters.
GenericDeviceConfig.Builder	setChannelNumber(int channelNumber) Sets the channel number (default value is UNASSIGNED if not set).
GenericDeviceConfig.Builder	setControllerName(java.lang.String controllerName) Sets the controller name (default value is null if not set).
GenericDeviceConfig.Builder	setControllerNumber(int controllerNumber) Sets the controller number (default value is UNASSIGNED if not set).
GenericDeviceConfig.Builder	setInputBufferSize(int inputBufferSize) Sets the requested input buffer size (default value is UNASSIGNED if not set).
GenericDeviceConfig.Builder	setOutputBufferSize(int outputBufferSize) Sets the requested output buffer size (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

GenericDeviceConfig.Builder

public GenericDeviceConfig.Builder()

Method Detail

build

public GenericDeviceConfig build()

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

setControllerName

public GenericDeviceConfig.Builder setControllerName(java.lang.String controllerName)

Sets the controller name (default value is null if not set).

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems) or null.

Returns:

this Builder instance.

setChannelNumber

public GenericDeviceConfig.Builder setChannelNumber(int channelNumber)

Sets the channel number (default value is UNASSIGNED if not set).

Parameters:

channelNumber - the channel number (a positive or zero integer) or UNASSIGNED.

Returns:

this Builder instance.

Throws:

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

setControllerNumber

public GenericDeviceConfig.Builder setControllerNumber(int controllerNumber)

Sets the controller number (default value is UNASSIGNED if not set).

Parameters:

controllerNumber - the hardware converter's number (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 GenericDeviceConfig.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 GenericDeviceConfig.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.