Class ConfigurationManager

java.lang.Object

com.biglybt.core.config.impl.ConfigurationManager

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator

public class ConfigurationManager
extends Object
implements AEDiagnosticsEvidenceGenerator

A singleton used to store configuration into a bencoded file.

Field Summary

Fields

Modifier and Type	Field	Description
private static final AEMonitor	class_mon
private static ConfigurationManager	config
static final String	CONFIG_FILENAME
private static ConfigurationManager	config_temp
private static final boolean	DEBUG_PARAMETER_LISTENERS
private static final FrequencyLimitedDispatcher	dirty_dispatcher
private final ParameterListener	exportable_parameter_listener
private final Map<String,String[]>	exported_parameters
private boolean	exported_parameters_dirty
private final Map<String,String>	imported_parameters
private final List<COConfigurationListener>	listenerz
private final Map<String, ParameterListener[]>	parameterListenerz
private ConcurrentHashMapWrapper<String,Object>	propertiesMap
private final List<COConfigurationManager.ResetToDefaultsListener>	reset_to_def_listeners
private final List	transient_properties
private final Map<String, List<WeakReference<ParameterListener>>>	weakParameterListenerz

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConfigurationManager()
private	ConfigurationManager(Map data)

Method Summary

Modifier and Type	Method	Description
void	addAndFireListener(COConfigurationListener listener)
void	addListener(COConfigurationListener listener)
void	addParameterListener(String parameter, ParameterListener new_listener)
void	addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)
void	addWeakParameterListener(String parameter, ParameterListener new_listener)
protected static String	bytesToString(byte[] bytes)
boolean	doesParameterNonDefaultExist(String parameter)	Does the given parameter exist.
void	dumpConfigChanges(IndentWriter writer)
(package private) void	exportParameters()
void	generate(IndentWriter writer)
boolean	getBooleanParameter(String parameter)
boolean	getBooleanParameter(String parameter, boolean defaultValue)
byte[]	getByteParameter(String parameter)
byte[]	getByteParameter(String parameter, byte[] defaultValue)
private byte[]	getByteParameterRaw(String parameter)
Set<String>	getDefinedParameters()
String	getDirectoryParameter(String parameter)
float	getFloatParameter(String parameter)
float	getFloatParameter(String parameter, float def_val)
static ConfigurationManager	getInstance()
static ConfigurationManager	getInstance(Map data)
int	getIntParameter(String parameter)
int	getIntParameter(String parameter, int defaultValue)
List	getListParameter(String parameter, List def)
long	getLongParameter(String parameter)
long	getLongParameter(String parameter, long defaultValue)
private Long	getLongParameterRaw(String parameter)
Map	getMapParameter(String parameter, Map def)
Object	getParameter(String name)
int[]	getRGBParameter(String parameter)
List<String>	getStringListParameter(String parameter)
String	getStringParameter(String parameter)
private String	getStringParameter(String parameter, byte[] defaultValue)
String	getStringParameter(String parameter, String defaultValue)
boolean	hasParameter(String key, boolean explicit)	Returns true if a parameter with the given name exists.
private boolean	ignoreKeyForDump(String key)
protected void	initialise()
boolean	isNewInstall()
void	load()
void	load(String filename)
private void	loadExportedParameters()
private void	notifyParameterListeners(String parameter)
private boolean	notifyParameterListenersIfChanged(String parameter, byte[] newValue, byte[] oldValue)
private boolean	notifyParameterListenersIfChanged(String parameter, Long newValue, Long oldValue)
void	registerExportedParameter(String name, String key)
void	registerTransientParameter(String param)	Use this method to record a parameter as one which can be stored here, but shouldn't be saved in the .config file.
void	removeListener(COConfigurationListener listener)
boolean	removeParameter(String parameter)	Remove the given configuration parameter completely.
void	removeParameterListener(String parameter, ParameterListener listener)
boolean	removeRGBParameter(String parameter)
void	removeWeakParameterListener(String parameter, ParameterListener listener)	Explicitly removing a weak ParameterListener prevents it from being fired after being de-referenced, but before GC'd
void	resetToDefaults()
void	save()
void	save(String filename)
void	setDirty()
boolean	setParameter(String parameter, boolean value)
boolean	setParameter(String parameter, byte[] defaultValue)
boolean	setParameter(String parameter, float defaultValue)
boolean	setParameter(String parameter, int defaultValue)
boolean	setParameter(String parameter, long defaultValue)
boolean	setParameter(String parameter, String defaultValue)
boolean	setParameter(String parameter, List value)
boolean	setParameter(String parameter, Map value)
void	setParameterRawNoNotify(String parameter, Object value)	Set the raw parameter value to store in the properties map.
boolean	setRGBParameter(String parameter, int[] rgb, Boolean override)
boolean	setRGBParameter(String parameter, int red, int green, int blue, Boolean override)
protected static byte[]	stringToBytes(String str)
(package private) void	updateExportableParameter(String key)
boolean	verifyParameter(String parameter, String value)

Methods inherited from class Object

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

Field Details

DEBUG_PARAMETER_LISTENERS

private static final boolean DEBUG_PARAMETER_LISTENERS

See Also:

• Constant Field Values

CONFIG_FILENAME

public static final String CONFIG_FILENAME

See Also:

• Constant Field Values

config_temp

private static ConfigurationManager config_temp

config

private static ConfigurationManager config

class_mon

private static final AEMonitor class_mon

propertiesMap

private ConcurrentHashMapWrapper<String,Object> propertiesMap

transient_properties

private final List transient_properties

listenerz

private final List<COConfigurationListener> listenerz

parameterListenerz

private final Map<String, ParameterListener[]> parameterListenerz

weakParameterListenerz

private final Map<String, List<WeakReference<ParameterListener>>> weakParameterListenerz

reset_to_def_listeners

private final List<COConfigurationManager.ResetToDefaultsListener> reset_to_def_listeners

dirty_dispatcher

private static final FrequencyLimitedDispatcher dirty_dispatcher

exportable_parameter_listener

private final ParameterListener exportable_parameter_listener

exported_parameters

private final Map<String,String[]> exported_parameters

imported_parameters

private final Map<String,String> imported_parameters

exported_parameters_dirty

private volatile boolean exported_parameters_dirty

Constructor Details

ConfigurationManager

private ConfigurationManager()

ConfigurationManager

private ConfigurationManager(Map data)

Method Details

getInstance

public static ConfigurationManager getInstance()

getInstance

public static ConfigurationManager getInstance(Map data)

initialise

protected void initialise()

load

public void load(String filename)

load

public void load()

save

public void save(String filename)

save

public void save()

setDirty

public void setDirty()

isNewInstall

public boolean isNewInstall()

getDefinedParameters

public Set<String> getDefinedParameters()

getBooleanParameter

public boolean getBooleanParameter(String parameter,
 boolean defaultValue)

getBooleanParameter

public boolean getBooleanParameter(String parameter)

setParameter

public boolean setParameter(String parameter,
 boolean value)

getLongParameterRaw

private Long getLongParameterRaw(String parameter)

getIntParameter

public int getIntParameter(String parameter,
 int defaultValue)

getIntParameter

public int getIntParameter(String parameter)

getLongParameter

public long getLongParameter(String parameter,
 long defaultValue)

getLongParameter

public long getLongParameter(String parameter)

getByteParameterRaw

private byte[] getByteParameterRaw(String parameter)

getByteParameter

public byte[] getByteParameter(String parameter)

getByteParameter

public byte[] getByteParameter(String parameter,
 byte[] defaultValue)

getStringParameter

private String getStringParameter(String parameter,
 byte[] defaultValue)

getStringParameter

public String getStringParameter(String parameter,
 String defaultValue)

getStringParameter

public String getStringParameter(String parameter)

getStringListParameter

public List<String> getStringListParameter(String parameter)

getListParameter

public List getListParameter(String parameter,
 List def)

setParameter

public boolean setParameter(String parameter,
 List value)

getMapParameter

public Map getMapParameter(String parameter,
 Map def)

setParameter

public boolean setParameter(String parameter,
 Map value)

getDirectoryParameter

public String getDirectoryParameter(String parameter)
                             throws IOException

Throws:

IOException

getFloatParameter

public float getFloatParameter(String parameter)

getFloatParameter

public float getFloatParameter(String parameter,
 float def_val)

setParameter

public boolean setParameter(String parameter,
 float defaultValue)

setParameter

public boolean setParameter(String parameter,
 int defaultValue)

setParameter

public boolean setParameter(String parameter,
 long defaultValue)

setParameter

public boolean setParameter(String parameter,
 byte[] defaultValue)

setParameter

public boolean setParameter(String parameter,
 String defaultValue)

hasParameter

public boolean hasParameter(String key,
 boolean explicit)

Returns true if a parameter with the given name exists.

Parameters:

key - The name of the parameter to check.

explicit - If true, we only check for a value which is definitely stored explicitly, false means that we'll also check against configuration defaults too.

verifyParameter

public boolean verifyParameter(String parameter,
 String value)

setRGBParameter

public boolean setRGBParameter(String parameter,
 int red,
 int green,
 int blue,
 Boolean override)

setRGBParameter

public boolean setRGBParameter(String parameter,
 int[] rgb,
 Boolean override)

getRGBParameter

public int[] getRGBParameter(String parameter)

getParameter

public Object getParameter(String name)

setParameterRawNoNotify

public void setParameterRawNoNotify(String parameter,
 Object value)

Set the raw parameter value to store in the properties map. This should only be used by trusted callers, and has been added to support external plugin config files.

Parameters:

parameter - Parameter name.

value - A bencode-ably safe value.

registerTransientParameter

public void registerTransientParameter(String param)

Use this method to record a parameter as one which can be stored here, but shouldn't be saved in the .config file. Instead, some external object should be responsible for the parameter's persistency (if it should have any at all).

removeParameter

public boolean removeParameter(String parameter)

Remove the given configuration parameter completely.

Parameters:

parameter - to remove

Returns:

true if found and removed, false if not

removeRGBParameter

public boolean removeRGBParameter(String parameter)

doesParameterNonDefaultExist

public boolean doesParameterNonDefaultExist(String parameter)

Does the given parameter exist.

Parameters:

parameter - to check

Returns:

true if exists, false if not present

notifyParameterListenersIfChanged

private boolean notifyParameterListenersIfChanged(String parameter,
 Long newValue,
 Long oldValue)

notifyParameterListenersIfChanged

private boolean notifyParameterListenersIfChanged(String parameter,
 byte[] newValue,
 byte[] oldValue)

addResetToDefaultsListener

public void addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)

registerExportedParameter

public void registerExportedParameter(String name,
 String key)

updateExportableParameter

void updateExportableParameter(String key)

exportParameters

void exportParameters()

loadExportedParameters

private void loadExportedParameters()

resetToDefaults

public void resetToDefaults()

notifyParameterListeners

private void notifyParameterListeners(String parameter)

addWeakParameterListener

public void addWeakParameterListener(String parameter,
 ParameterListener new_listener)

removeWeakParameterListener

public void removeWeakParameterListener(String parameter,
 ParameterListener listener)

Explicitly removing a weak ParameterListener prevents it from being fired after being de-referenced, but before GC'd

addParameterListener

public void addParameterListener(String parameter,
 ParameterListener new_listener)

removeParameterListener

public void removeParameterListener(String parameter,
 ParameterListener listener)

addListener

public void addListener(COConfigurationListener listener)

addAndFireListener

public void addAndFireListener(COConfigurationListener listener)

removeListener

public void removeListener(COConfigurationListener listener)

ignoreKeyForDump

private boolean ignoreKeyForDump(String key)

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator

dumpConfigChanges

public void dumpConfigChanges(IndentWriter writer)

bytesToString

protected static String bytesToString(byte[] bytes)

stringToBytes

protected static byte[] stringToBytes(String str)