StorageManager (Toolsverse API Reference 5.9)

Object
- com.toolsverse.storage.StorageManager

All Implemented Interfaces:

PersistableStorage, StorageProvider, ObjectStorage
```
public class StorageManager
extends Object
implements StorageProvider, ObjectStorage, PersistableStorage
```
The singleton class which includes all property management and retrieval related functions. Use it if you need to load\store\get\set\delete properties.

Since:

2.0

Version:

2.0

Nested Class Summary
- Nested classes/interfaces inherited from interface com.toolsverse.storage.StorageProvider
  StorageProvider.StorageObject

Field Summary
- Fields inherited from interface com.toolsverse.storage.StorageProvider
  GLOBAL, LOCAL, SESSION

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBooleanProperty(String key)` Gets the boolean property.
`boolean`	`getBooleanProperty(String key, boolean def)` Gets the boolean property.
`Date`	`getDateProperty(String key, Date def, String format)` Gets the date property.
`Date`	`getDateProperty(String key, String format)` Gets the date property.
`double`	`getDoubleProperty(String key)` Gets the double property.
`double`	`getDoubleProperty(String key, double def)` Gets the double property.
`float`	`getFloatProperty(String key)` Gets the float property.
`float`	`getFloatProperty(String key, float def)` Gets the float property.
`int`	`getIntProperty(String key)` Gets the int property.
`int`	`getIntProperty(String key, int def)` Gets the int property.
`long`	`getLongProperty(String key)` Gets the long property.
`long`	`getLongProperty(String key, long def)` Gets the long property.
`Number`	`getNumberProperty(String key)` Gets the number property.
`Number`	`getNumberProperty(String key, Number def)` Gets the number property.
`Map<String,StorageProvider.StorageObject>`	`getProperties()` Gets the properties.
`Object`	`getProperty(String key)` Gets the property.
`Object`	`getProperty(String key, Object def)` Gets the property.
`String`	`getString(String key)` Gets the string representation of the value by the key.
`String`	`getStringProperty(String key)` Gets the string property.
`String`	`getStringProperty(String key, String def)` Gets the string property.
`Object`	`getValue(String key)` Gets the value by the key.
`void`	`init()` Initializes the storage.
`void`	`initProvider()` Initializes the StorageProvider.
`static StorageManager`	`instance()` Returns an instance of the StorageManager.
`void`	`load()` Loads properties.
`void`	`load(List<String> keys)` Loads only properties which belong to the given keys list.
`Object`	`removeProperty(String key)` Removes the property.
`void`	`setProperties(String text)` Sets the properties by parsing string like key;value\|key;value.
`Object`	`setProperty(String key, Object value)` Sets the property.
`Object`	`setProperty(String key, StorageProvider.StorageObject value)` Sets the property.
`void`	`setValue(String key, Object value)` Associates value with the key.
`void`	`store()` Stores properties.
`void`	`store(Map<String,StorageProvider.StorageObject> properties)` Stores only given properties.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - instance
```
public static StorageManager instance()
```
    Returns an instance of the StorageManager.
    
    Returns:
    
    the storage manager
  - getBooleanProperty
```
public boolean getBooleanProperty(String key)
```
    Gets the boolean property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the boolean property. If value == null throws IllegalStateException("Property must have a value") exception.
  - getBooleanProperty
```
public boolean getBooleanProperty(String key,
                                  boolean def)
```
    Gets the boolean property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the boolean property
  - getDateProperty
```
public Date getDateProperty(String key,
                            Date def,
                            String format)
```
    Gets the date property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    format - the format
    
    Returns:
    
    the date property
  - getDateProperty
```
public Date getDateProperty(String key,
                            String format)
```
    Gets the date property.
    
    Parameters:
    
    key - the key
    
    format - the format
    
    Returns:
    
    the date property. If value == null throws IllegalStateException("Property must have a value") exception.
  - getDoubleProperty
```
public double getDoubleProperty(String key)
```
    Gets the double property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the double property. If value == null throws IllegalStateException("Property must have a value") exception.
  - getDoubleProperty
```
public double getDoubleProperty(String key,
                                double def)
```
    Gets the double property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the double property
  - getFloatProperty
```
public float getFloatProperty(String key)
```
    Gets the float property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the float property. If value == null throws IllegalStateException("Property must have a value") exception.
  - getFloatProperty
```
public float getFloatProperty(String key,
                              float def)
```
    Gets the float property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the float property
  - getIntProperty
```
public int getIntProperty(String key)
```
    Gets the int property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the int property, If value == null throws IllegalStateException("Property must have a value") exception.
  - getIntProperty
```
public int getIntProperty(String key,
                          int def)
```
    Gets the int property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the int property
  - getLongProperty
```
public long getLongProperty(String key)
```
    Gets the long property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the long property. If value == null throws IllegalStateException("Property must have a value") exception.
  - getLongProperty
```
public long getLongProperty(String key,
                            long def)
```
    Gets the long property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the long property
  - getNumberProperty
```
public Number getNumberProperty(String key)
```
    Gets the number property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the number property
  - getNumberProperty
```
public Number getNumberProperty(String key,
                                Number def)
```
    Gets the number property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the number property
  - getProperties
```
public Map<String,StorageProvider.StorageObject> getProperties()
```
    Description copied from interface: StorageProvider
    
    Gets the properties.
    
    Specified by:
    
    getProperties in interface StorageProvider
    
    Returns:
    
    the properties
  - getProperty
```
public Object getProperty(String key)
```
    Description copied from interface: StorageProvider
    
    Gets the property.
    
    Specified by:
    
    getProperty in interface StorageProvider
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the property
  - getProperty
```
public Object getProperty(String key,
                          Object def)
```
    Description copied from interface: StorageProvider
    
    Gets the property.
    
    Specified by:
    
    getProperty in interface StorageProvider
    
    Parameters:
    
    key - the key
    
    def - the def
    
    Returns:
    
    the property
  - getString
```
public String getString(String key)
```
    Description copied from interface: ObjectStorage
    
    Gets the string representation of the value by the key.
    
    Specified by:
    
    getString in interface ObjectStorage
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the string representation of the value or null if there is no mapping between key and value
  - getStringProperty
```
public String getStringProperty(String key)
```
    Gets the string property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the string property
  - getStringProperty
```
public String getStringProperty(String key,
                                String def)
```
    Gets the string property.
    
    Parameters:
    
    key - the key
    
    def - the default value
    
    Returns:
    
    the string property
  - getValue
```
public Object getValue(String key)
```
    Description copied from interface: ObjectStorage
    
    Gets the value by the key.
    
    Specified by:
    
    getValue in interface ObjectStorage
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if there is no mapping between key and value
  - init
```
public void init()
          throws Exception
```
    Description copied from interface: PersistableStorage
    
    Initializes the storage.
    
    Specified by:
    
    init in interface PersistableStorage
    
    Throws:
    
    Exception - in case of any error
  - initProvider
```
public void initProvider()
```
    Initializes the StorageProvider.
  - load
```
public void load()
          throws Exception
```
    Description copied from interface: PersistableStorage
    
    Loads properties.
    
    Specified by:
    
    load in interface PersistableStorage
    
    Throws:
    
    Exception - in case of any error
  - load
```
public void load(List<String> keys)
          throws Exception
```
    Description copied from interface: PersistableStorage
    
    Loads only properties which belong to the given keys list.
    
    Specified by:
    
    load in interface PersistableStorage
    
    Parameters:
    
    keys - the keys
    
    Throws:
    
    Exception - in case of any error
  - removeProperty
```
public Object removeProperty(String key)
```
    Description copied from interface: StorageProvider
    
    Removes the property.
    
    Specified by:
    
    removeProperty in interface StorageProvider
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the object
  - setProperties
```
public void setProperties(String text)
```
    Sets the properties by parsing string like key;value|key;value.
    
    Parameters:
    
    text - the new properties
  - setProperty
```
public Object setProperty(String key,
                          Object value)
```
    Sets the property.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the object
  - setProperty
```
public Object setProperty(String key,
                          StorageProvider.StorageObject value)
```
    Description copied from interface: StorageProvider
    
    Sets the property.
    
    Specified by:
    
    setProperty in interface StorageProvider
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the object
  - setValue
```
public void setValue(String key,
                     Object value)
```
    Description copied from interface: ObjectStorage
    
    Associates value with the key. Key can not be null.
    
    Specified by:
    
    setValue in interface ObjectStorage
    
    Parameters:
    
    key - the key
    
    value - the value
  - store
```
public void store()
           throws Exception
```
    Description copied from interface: PersistableStorage
    
    Stores properties.
    
    Specified by:
    
    store in interface PersistableStorage
    
    Throws:
    
    Exception - in case of any error
  - store
```
public void store(Map<String,StorageProvider.StorageObject> properties)
           throws Exception
```
    Description copied from interface: PersistableStorage
    
    Stores only given properties.
    
    Specified by:
    
    store in interface PersistableStorage
    
    Parameters:
    
    properties - the properties
    
    Throws:
    
    Exception - in case of any error

Class StorageManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.toolsverse.storage.StorageProvider

Field Summary

Fields inherited from interface com.toolsverse.storage.StorageProvider

Method Summary

Methods inherited from class Object

Method Detail

instance

getBooleanProperty

getBooleanProperty

getDateProperty

getDateProperty

getDoubleProperty

getDoubleProperty

getFloatProperty

getFloatProperty

getIntProperty

getIntProperty

getLongProperty

getLongProperty

getNumberProperty

getNumberProperty

getProperties

getProperty

getProperty

getString

getStringProperty

getStringProperty

getValue

init

initProvider

load

load

removeProperty

setProperties

setProperty

setProperty

setValue

store

store