LocalDeviceConfig (Hazelcast Root 5.3.0-BETA-1 API)

java.lang.Object
- com.hazelcast.config.LocalDeviceConfig

All Implemented Interfaces:

DeviceConfig, NamedConfig
```
public final class LocalDeviceConfig
extends Object
implements DeviceConfig
```
Local Device configuration for the Tiered-Store.

Since:

5.1

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BLOCK_SIZE_IN_BYTES` Default block/sector size in bytes.
`static Capacity`	`DEFAULT_CAPACITY` Default device capacity.
`static String`	`DEFAULT_DEVICE_BASE_DIR` Default base directory for the device.
`static String`	`DEFAULT_DEVICE_NAME` Default device name.
`static int`	`DEFAULT_READ_IO_THREAD_COUNT` Default read IO thread count.
`static int`	`DEFAULT_WRITE_IO_THREAD_COUNT` Default write IO thread count.

Constructor Summary

Constructors
Constructor and Description

LocalDeviceConfig()

LocalDeviceConfig(LocalDeviceConfig localDeviceConfig)

Constructors
Constructor and Description
`LocalDeviceConfig()`
`LocalDeviceConfig(LocalDeviceConfig localDeviceConfig)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`File`	`getBaseDir()` Base directory for this device.
`int`	`getBlockSize()` Returns disk block/sector size in bytes.
`Capacity`	`getCapacity()` Returns the capacity of this device.
`String`	`getName()` Returns the device name.
`int`	`getReadIOThreadCount()` Returns the read IO thread count;
`int`	`getWriteIOThreadCount()` Returns the write IO thread count
`int`	`hashCode()`
`boolean`	`isLocal()` Returns `true` since `this` is a configuration for a local device.
`LocalDeviceConfig`	`setBaseDir(File baseDir)` Sets the base directory for this device.
`LocalDeviceConfig`	`setBlockSize(int blockSize)` Sets the disk block/sector size in bytes.
`LocalDeviceConfig`	`setCapacity(Capacity capacity)` Sets the capacity of this device.
`LocalDeviceConfig`	`setName(String name)` Sets the device name.
`LocalDeviceConfig`	`setReadIOThreadCount(int readIOThreadCount)` Sets the read IO thread count.
`LocalDeviceConfig`	`setWriteIOThreadCount(int writeIOThreadCount)` Sets the write IO thread count.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_DEVICE_NAME
```
public static final String DEFAULT_DEVICE_NAME
```
    Default device name.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DEVICE_BASE_DIR
```
public static final String DEFAULT_DEVICE_BASE_DIR
```
    Default base directory for the device.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCK_SIZE_IN_BYTES
```
public static final int DEFAULT_BLOCK_SIZE_IN_BYTES
```
    Default block/sector size in bytes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_IO_THREAD_COUNT
```
public static final int DEFAULT_READ_IO_THREAD_COUNT
```
    Default read IO thread count.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WRITE_IO_THREAD_COUNT
```
public static final int DEFAULT_WRITE_IO_THREAD_COUNT
```
    Default write IO thread count.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CAPACITY
```
public static final Capacity DEFAULT_CAPACITY
```
    Default device capacity. It is 256 GB.
- Constructor Detail
  - LocalDeviceConfig
```
public LocalDeviceConfig()
```
  - LocalDeviceConfig
```
public LocalDeviceConfig(LocalDeviceConfig localDeviceConfig)
```
- Method Detail
  - getName
```
public String getName()
```
    Returns the device name.
    
    Specified by:
    
    getName in interface NamedConfig
  - setName
```
public LocalDeviceConfig setName(@Nonnull
                                 String name)
```
    Sets the device name.
    
    Specified by:
    
    setName in interface NamedConfig
    
    Parameters:
    
    name - device name
    
    Returns:
    
    this DeviceConfig
  - getBaseDir
```
public File getBaseDir()
```
    Base directory for this device. Can be an absolute or relative path to the node startup directory.
  - setBaseDir
```
public LocalDeviceConfig setBaseDir(@Nonnull
                                    File baseDir)
```
    Sets the base directory for this device.
    
    Parameters:
    
    baseDir - base directory.
    
    Returns:
    
    this DeviceConfig
  - getCapacity
```
public Capacity getCapacity()
```
    Returns the capacity of this device.
    
    Specified by:
    
    getCapacity in interface DeviceConfig
    
    Returns:
    
    device capacity.
  - setCapacity
```
public LocalDeviceConfig setCapacity(Capacity capacity)
```
    Sets the capacity of this device.
    
    Parameters:
    
    capacity - capacity.
    
    Returns:
    
    this LocalDeviceConfig
  - getBlockSize
```
public int getBlockSize()
```
    Returns disk block/sector size in bytes.
    
    Returns:
    
    block size
  - setBlockSize
```
public LocalDeviceConfig setBlockSize(int blockSize)
```
    Sets the disk block/sector size in bytes.
    
    Parameters:
    
    blockSize - block size.
    
    Returns:
    
    this DeviceConfig
  - getReadIOThreadCount
```
public int getReadIOThreadCount()
```
    Returns the read IO thread count;
    
    Returns:
    
    read IO thread count
  - setReadIOThreadCount
```
public LocalDeviceConfig setReadIOThreadCount(int readIOThreadCount)
```
    Sets the read IO thread count.
    
    Parameters:
    
    readIOThreadCount - read IO thread count
    
    Returns:
    
    this DeviceConfig
  - getWriteIOThreadCount
```
public int getWriteIOThreadCount()
```
    Returns the write IO thread count
    
    Returns:
    
    write IO thread count
  - setWriteIOThreadCount
```
public LocalDeviceConfig setWriteIOThreadCount(int writeIOThreadCount)
```
    Sets the write IO thread count.
    
    Parameters:
    
    writeIOThreadCount - write IO thread count
    
    Returns:
    
    this DeviceConfig
  - isLocal
```
public boolean isLocal()
```
    Returns true since this is a configuration for a local device.
    
    Specified by:
    
    isLocal in interface DeviceConfig
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LocalDeviceConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DEVICE_NAME

DEFAULT_DEVICE_BASE_DIR

DEFAULT_BLOCK_SIZE_IN_BYTES

DEFAULT_READ_IO_THREAD_COUNT

DEFAULT_WRITE_IO_THREAD_COUNT

DEFAULT_CAPACITY

Constructor Detail

LocalDeviceConfig

LocalDeviceConfig

Method Detail

getName

setName

getBaseDir

setBaseDir

getCapacity

setCapacity

getBlockSize

setBlockSize

getReadIOThreadCount

setReadIOThreadCount

getWriteIOThreadCount

setWriteIOThreadCount

isLocal

equals

hashCode

toString