jhelp.util.preference

Class PreferencesSerializer

java.lang.Object

jhelp.util.thread.ThreadedTask<java.lang.Void,java.lang.Void,java.lang.Void>

jhelp.util.preference.PreferencesSerializer

All Implemented Interfaces:

PreferencesFileConstants

 class PreferencesSerializer
extends ThreadedTask<java.lang.Void,java.lang.Void,java.lang.Void>
implements PreferencesFileConstants

Serialize preferences in XML

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private Mutex	mutex Lock for synchronization
private java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>>	preferences Preferences to serialize
private java.io.File	preferencesFile File where write XML
private boolean	serializeAgain Indicates if a new serialization is need
private boolean	serializing Indicates if we are in serializing

Fields inherited from interface jhelp.util.preference.PreferencesFileConstants

MARKUP_PREFERENCE, MARKUP_PREFERENCES, PARAMETER_NAME, PARAMETER_TYPE, PARAMETER_VALUE

Constructor Summary

Constructors

Constructor and Description
PreferencesSerializer(java.io.File preferencesFile, java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>> preferences) Create a new instance of PreferencesSerializer

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Void	doThreadAction(java.lang.Void parameter) Do the serialization in separate thread Parent documentation: Call when the turn of this thread comes.
void	serialize() Serialize the preferences as soon as possible
protected void	setResult(java.lang.Void result) Call when serialization is finish Parent documentation: Call when task is finish.

Methods inherited from class jhelp.util.thread.ThreadedTask

cancel, canceled, doProgress, postProgress

Methods inherited from class java.lang.Object

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

Field Detail

mutex

private final Mutex mutex

Lock for synchronization

preferences

private final java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>> preferences

Preferences to serialize

preferencesFile

private final java.io.File preferencesFile

File where write XML

serializeAgain

private boolean serializeAgain

Indicates if a new serialization is need

serializing

private boolean serializing

Indicates if we are in serializing

Constructor Detail

PreferencesSerializer

PreferencesSerializer(java.io.File preferencesFile,
                     java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>> preferences)

Create a new instance of PreferencesSerializer

Parameters:

preferencesFile - Preference files where write preferences

preferences - Preferences to serialize

Method Detail

doThreadAction

protected java.lang.Void doThreadAction(java.lang.Void parameter)

Do the serialization in separate thread

Parent documentation:
Call when the turn of this thread comes.
It does the action and compute the result

Specified by:

doThreadAction in class ThreadedTask<java.lang.Void,java.lang.Void,java.lang.Void>

Parameters:

parameter - Unused

Returns:

null

See Also:

ThreadedTask.doThreadAction(java.lang.Object)

setResult

protected void setResult(java.lang.Void result)

Call when serialization is finish

Parent documentation:
Call when task is finish.
Override this method to do something when computing is finish, do nothing by default

Overrides:

setResult in class ThreadedTask<java.lang.Void,java.lang.Void,java.lang.Void>

Parameters:

result - Unused

See Also:

ThreadedTask.setResult(java.lang.Object)

serialize

public void serialize()

Serialize the preferences as soon as possible