jdk.dio.mmio

Class MMIODeviceConfig.Builder

java.lang.Object

jdk.dio.mmio.MMIODeviceConfig.Builder

Enclosing class:

MMIODeviceConfig

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

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

   MMIODeviceConfig config = new MMIODeviceConfig.Builder()
           .setControllerNumber(1)
           .setAddress(0x0000FFFF)
           .setSize(64)
           .setByteOrder(ByteOrder.LITTLE_ENDIAN)
           .setRawMemoryConfigs(
               new MMIODeviceConfig.RawRegisterConfig<>(0x00, "Seconds", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x01, "SecAlarm", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x02, "Minutes", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x03, "MinAlarm", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x04, "Hours", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x05, "HrAlarm", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x06, "DayOfWk", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x07, "DayOfMo", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x08, "Month", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x09, "Year", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x0A, "RegisterA", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x0B, "RegisterB", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x0C, "RegisterC", Byte.class),
               new MMIODeviceConfig.RawRegisterConfig<>(0x0D, "RegisterD", Byte.class),
               new MMIODeviceConfig.RawBlockConfig(0x0E, "UserRam", 50)))
           .build();
 

Since:

1.1

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MMIODeviceConfig	build() Creates a new MMIODeviceConfig instance initialized with the values set for each configuration parameters.
MMIODeviceConfig.Builder	setAddress(long address) Sets the base memory address of the device.
MMIODeviceConfig.Builder	setByteOrder(java.nio.ByteOrder byteOrder) Sets the byte order of the device (default value, if not set, is the native byte order of the underlying platform as returned by ByteOrder.nativeOrder()).
MMIODeviceConfig.Builder	setControllerName(java.lang.String controllerName) Sets the controller name (default value is null if not set).
MMIODeviceConfig.Builder	setControllerNumber(int controllerNumber) Sets the controller number (default value is UNASSIGNED if not set).
MMIODeviceConfig.Builder	setRawMemoryConfigs(MMIODeviceConfig.RawMemoryConfig... memConfigs) Sets the raw block and raw register configurations (default value is null if not set).
MMIODeviceConfig.Builder	setSize(int size) Sets the size of the memory-mapped area of the device (a positive integer).

Methods inherited from class java.lang.Object

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

Constructor Detail

MMIODeviceConfig.Builder

public MMIODeviceConfig.Builder()

Creates a new Builder instance.

Method Detail

build

public MMIODeviceConfig build()

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

Throws:

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

• if size of the memory-mapped area is greater than (Long.MAX_VALUE - address), where address is the base address of the device,
• if any of the memConfigs elements is pointing outside of the defined address range ([ 0 - (size - 1)]), where size is the size of the memory-mapped area.

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

• the memory address of the device is not set.
• the size of the memory-mapped area of the device is not set.

setControllerName

public MMIODeviceConfig.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.

setAddress

public MMIODeviceConfig.Builder setAddress(long address)

Sets the base memory address of the device.

Parameters:

address - the memory address of the device (a positive or zero integer).

Returns:

this Builder instance.

Throws:

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

setControllerNumber

public MMIODeviceConfig.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.

setSize

public MMIODeviceConfig.Builder setSize(int size)

Sets the size of the memory-mapped area of the device (a positive integer).

Parameters:

size - the size of the memory-mapped area of the device (a positive integer).

Returns:

this Builder instance.

Throws:

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

setByteOrder

public MMIODeviceConfig.Builder setByteOrder(java.nio.ByteOrder byteOrder)

Sets the byte order of the device (default value, if not set, is the native byte order of the underlying platform as returned by ByteOrder.nativeOrder()).

Parameters:

byteOrder - the byte order of the device.

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if byteOrder is null.

setRawMemoryConfigs

public MMIODeviceConfig.Builder setRawMemoryConfigs(MMIODeviceConfig.RawMemoryConfig... memConfigs)

Sets the raw block and raw register configurations (default value is null if not set).

Parameters:

memConfigs - the raw block and raw register configurations (may be null or empty).

Returns:

this Builder instance.

Throws:

java.lang.NullPointerException - if any component of the (non-null, non-empty) memConfigs array is null.