Config (Ametys 4.2.x

java.lang.Object
- org.ametys.runtime.config.Config

public final class Config
extends Object

Bean to read / Write config file

Field Summary

Fields
Modifier and Type	Field and Description
`private static Config`	`__config`
`private static boolean`	`__fileExists`
`private static String`	`__filename`
`private static boolean`	`__initialized`
`private static long`	`__lastModified`
`private static Logger`	`__logger`
`private static Model`	`__model`
`private Map<String,DefinitionAndValue>`	`_definitionAndValues`

Constructor Summary

Constructors
Modifier Constructor and Description

private Config()

Constructors
Modifier	Constructor and Description
`private`	`Config()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) static Map<String,Object>`	`__extractValues(Map<String,DefinitionAndValue> definitionAndValues)`
`(package private) static Map<String,DefinitionAndValue>`	`__read()` Read configuration file
`private void`	`_load()`
`private void`	`_reloadIfNeeded()`
`static void`	`dispose()` Dispose this `Config` instance
`static boolean`	`fileExists()` Returns true if the configuration filename exists.
`static Config`	`getInstance()` Get the instance of Config using the config file.
`<T> T`	`getValue(String name)` Retrieves the typed parameter value
`<T> T`	`getValue(String name, boolean useDefaultFromModel, T defaultValue)` Retrieves the typed parameter value, or the default value
`Map<String,Object>`	`getValues()` Retrieves all configuration parameter values
`static Map<String,Object>`	`getValuesAsJSONForClient()` Retrieves all configuration parameter values as JSON objects
`static void`	`setFilename(String filename)` Set the configuration filename
`static void`	`setInitialized(boolean initialized)` Set the initialization status of the configuration
`static void`	`setModel(Model model)` Sets the configuration model

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

- Field Detail
  - __logger
```
private static Logger __logger
```
  - __config
```
private static Config __config
```
  - __initialized
```
private static boolean __initialized
```
  - __filename
```
private static String __filename
```
  - __fileExists
```
private static boolean __fileExists
```
  - __lastModified
```
private static long __lastModified
```
  - __model
```
private static Model __model
```
  - _definitionAndValues
```
private Map<String,DefinitionAndValue> _definitionAndValues
```
- Constructor Detail
  - Config
```
private Config()
```
- Method Detail
  - getInstance
```
public static Config getInstance()
```
    Get the instance of Config using the config file.
    
    Returns:
    
    An instance of Config containing config file values and definition, or null if config file cannot be read.
  - setModel
```
public static void setModel(Model model)
```
    Sets the configuration model
    
    Parameters:
    
    model - the model to set
  - _load
```
private void _load()
            throws Exception
```
    Throws:
    
    Exception
  - _reloadIfNeeded
```
private void _reloadIfNeeded()
```
  - __read
```
static Map<String,DefinitionAndValue> __read()
                                      throws Exception
```
    Read configuration file
    
    Returns:
    
    the configuration definition and values
    
    Throws:
    
    Exception - if a problem occurs reading values
  - setInitialized
```
public static void setInitialized(boolean initialized)
```
    Set the initialization status of the configuration
    
    Parameters:
    
    initialized - the initialization status of the configuration
  - setFilename
```
public static void setFilename(String filename)
```
    Set the configuration filename
    
    Parameters:
    
    filename - Name with path of the configuration file
  - fileExists
```
public static boolean fileExists()
```
    Returns true if the configuration filename exists.
    
    Returns:
    
    true if the configuration filename exists.
  - getValues
```
public Map<String,Object> getValues()
```
    Retrieves all configuration parameter values
    
    Returns:
    
    the configuration values
  - __extractValues
```
static Map<String,Object> __extractValues(Map<String,DefinitionAndValue> definitionAndValues)
```
  - getValuesAsJSONForClient
```
public static Map<String,Object> getValuesAsJSONForClient()
```
    Retrieves all configuration parameter values as JSON objects
    
    Returns:
    
    the configuration values as JSON objects
  - getValue
```
public <T> T getValue(String name)
```
    Retrieves the typed parameter value
    
    Type Parameters:
    
    T - type of the value to retrieve
    
    Parameters:
    
    name - name of the configuration parameter
    
    Returns:
    
    the parameter value
  - getValue
```
public <T> T getValue(String name,
                      boolean useDefaultFromModel,
                      T defaultValue)
```
    Retrieves the typed parameter value, or the default value
    
    Type Parameters:
    
    T - type of the value to retrieve
    
    Parameters:
    
    name - name of the configuration parameter
    
    useDefaultFromModel - true to use the default value from the model, false to use the give default value
    
    defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model
    
    Returns:
    
    the parameter value
  - dispose
```
public static void dispose()
```
    Dispose this Config instance

Class Config

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__logger

__config

__initialized

__filename

__fileExists

__lastModified

__model

_definitionAndValues

Constructor Detail

Config

Method Detail

getInstance

setModel

_load

_reloadIfNeeded

__read

setInitialized

setFilename

fileExists

getValues

__extractValues

getValuesAsJSONForClient

getValue

getValue

dispose