repicea.app

Class SettingMemory

java.lang.Object

repicea.app.SettingMemory

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Memorizable

Direct Known Subclasses:

WindowSettings

public class SettingMemory
extends java.lang.Object
implements Memorizable, java.io.Closeable

The class SettingMemory makes it possible to record properties in a Map object and to retrieve them afterwards.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filename
protected java.nio.channels.FileLock	lock
protected java.io.RandomAccessFile	raf
protected java.util.HashMap<java.lang.String,java.lang.String>	stringProperties

Constructor Summary

Constructors

Constructor and Description
SettingMemory() Constructor with default filename, which is java.io.tmpdir / settings.ser.
SettingMemory(java.lang.String filename) Constructor with filename.

Method Summary

Modifier and Type	Method and Description
void	close()
MemorizerPackage	getMemorizerPackage() This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.
boolean	getProperty(java.lang.String property, boolean defaultValue) This method returns a previously saved property or a default value if the property has not been set yet.
double	getProperty(java.lang.String property, double defaultValue) This method returns a previously saved property or a default value if the property has not been set yet.
int	getProperty(java.lang.String property, int defaultValue) This method returns a previously saved property or a default value if the property has not been set yet.
java.lang.String	getProperty(java.lang.String property, java.lang.String defaultValue) This method returns a previously saved property or a default value if the property has not been set yet.
java.util.Map<java.lang.String,java.lang.String>	getStringProperties() This method returns the Map of properties.
protected void	loadSettings() This method deserializes the settings.
protected void	saveSettings() This method serializes the settings in the file denoted by the filename variable.
void	setProperty(java.lang.String property, boolean value) This method set a particular property.
void	setProperty(java.lang.String property, double value) This method set a particular property.
void	setProperty(java.lang.String property, int value) This method set a particular property.
void	setProperty(java.lang.String property, java.lang.String value) This method set a particular property.
void	unpackMemorizerPackage(MemorizerPackage wasMemorized) This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected java.lang.String filename

stringProperties

protected java.util.HashMap<java.lang.String,java.lang.String> stringProperties

raf

protected java.io.RandomAccessFile raf

lock

protected java.nio.channels.FileLock lock

Constructor Detail

SettingMemory

public SettingMemory()

Constructor with default filename, which is java.io.tmpdir / settings.ser.

SettingMemory

public SettingMemory(java.lang.String filename)

Constructor with filename.

Parameters:

filename - the file in which the settings are serialized

Method Detail

saveSettings

protected void saveSettings()

This method serializes the settings in the file denoted by the filename variable.

loadSettings

protected void loadSettings()

This method deserializes the settings.

getStringProperties

public java.util.Map<java.lang.String,java.lang.String> getStringProperties()

This method returns the Map of properties. It instantiates the map if it has not been instantiated before.

Returns:

a Map of Strings as keys and Strings as values

setProperty

public void setProperty(java.lang.String property,
                        java.lang.String value)

This method set a particular property.

Parameters:

property - a String

value - a String

setProperty

public void setProperty(java.lang.String property,
                        double value)

This method set a particular property.

Parameters:

property - a String

value - a Double

setProperty

public void setProperty(java.lang.String property,
                        boolean value)

This method set a particular property.

Parameters:

property - a String

value - a Boolean

setProperty

public void setProperty(java.lang.String property,
                        int value)

This method set a particular property.

Parameters:

property - a String

value - an Integer

getProperty

public java.lang.String getProperty(java.lang.String property,
                                    java.lang.String defaultValue)

This method returns a previously saved property or a default value if the property has not been set yet.

Parameters:

property - the property name

defaultValue - the default value of the property

Returns:

a String

getProperty

public double getProperty(java.lang.String property,
                          double defaultValue)

This method returns a previously saved property or a default value if the property has not been set yet.

Parameters:

property - the property name

defaultValue - the default value of the property

Returns:

a double

getProperty

public boolean getProperty(java.lang.String property,
                           boolean defaultValue)

This method returns a previously saved property or a default value if the property has not been set yet.

Parameters:

property - the property name

defaultValue - the default value of the property

Returns:

a boolean

getProperty

public int getProperty(java.lang.String property,
                       int defaultValue)

This method returns a previously saved property or a default value if the property has not been set yet.

Parameters:

property - the property name

defaultValue - the default value of the property

Returns:

an integer

getMemorizerPackage

public final MemorizerPackage getMemorizerPackage()

Description copied from interface: Memorizable

This method creates a MemorizerPackage instance that can be sent in turn to the TemporaryMemorizer instance for serialization.

Specified by:

getMemorizerPackage in interface Memorizable

Returns:

a MemorizerPackage instance

unpackMemorizerPackage

public final void unpackMemorizerPackage(MemorizerPackage wasMemorized)

Description copied from interface: Memorizable

This method unpacks the MemorizerPackage instance retrieved by the TemporaryMemorizer class.

Specified by:

unpackMemorizerPackage in interface Memorizable

Parameters:

wasMemorized - a MemorizerPackage instance

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException