FileBasedSettings (CME STP (Straight Through Processing) Handler Parent 3.6.0 API)

java.lang.Object
- biz.onixs.util.settings.Settings
- - biz.onixs.util.settings.FileBasedSettings

```
public class FileBasedSettings
extends Settings
```
The Settings implementation backed with the file. The keys values are case-sensitive.

Constructor Summary

Constructors
Constructor Description

FileBasedSettings(File stream)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`void`	`flush(boolean metadata)`	Flushes file data to stable storage.
`File`	`getStream()`
`void`	`load()`
`void`	`setLong(String key, long value, boolean flush)`	Sets the value corresponding to the given key.

Methods inherited from class biz.onixs.util.settings.Settings
getBoolean, getBoolean, getInteger, getInteger, getLong, getLong, getString, getString, isDefined, setBoolean, setBoolean, setInteger, setInteger, setLong, setString, setString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileBasedSettings
```
public FileBasedSettings(File stream)
```
- Method Detail
  - getStream
```
public File getStream()
```
  - flush
```
public void flush(boolean metadata)
           throws IOException
```
    Flushes file data to stable storage.
    When metadata is true, both file data and metadata (e.g., file size) are forced to disk. When false, only file data is flushed.
    
    Parameters:
    
    metadata - whether file metadata should also be flushed
    
    Throws:
    
    IOException - if the flush operation fails
  - load
```
public void load()
          throws IOException
```
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Throws:
    
    IOException
  - setLong
```
public void setLong(String key,
                    long value,
                    boolean flush)
             throws IOException
```
    Description copied from class: Settings
    
    Sets the value corresponding to the given key.
    
    Overrides:
    
    setLong in class Settings
    
    Parameters:
    
    key - key
    
    value - value
    
    flush - whether to save to persistent storage immediately
    
    Throws:
    
    IOException - if value storing failed