Package org.eclipse.jface.dialogs
Class DialogSettings
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogSettings
-
- All Implemented Interfaces:
IDialogSettings
public class DialogSettings extends Object implements IDialogSettings
Concrete implementation of a dialog settings (IDialogSettings) using a hash table and XML. The dialog store can be read from and saved to a stream. All keys and values must be strings or array of strings. Primitive types are converted to strings.This class was not designed to be subclassed. Here is an example of using a DialogSettings:
DialogSettings settings = new DialogSettings("root"); settings.put("Boolean1",true); settings.put("Long1",100); settings.put("Array1",new String[]{"aaaa1","bbbb1","cccc1"}); DialogSettings section = new DialogSettings("sectionName"); settings.addSection(section); section.put("Int2",200); section.put("Float2",1.1); section.put("Array2",new String[]{"aaaa2","bbbb2","cccc2"}); settings.save("c:\\temp\\test\\dialog.xml");- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Constructor Summary
Constructors Constructor Description DialogSettings(String sectionName)Create an empty dialog settings which loads and saves its content to a file.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IDialogSettingsaddNewSection(String sectionName)Create a new section in the receiver and return it.voidaddSection(IDialogSettings section)Add a section in the receiver.Stringget(String key)Returns the value of the given key in this dialog settings.String[]getArray(String key)Returns the value, an array of strings, of the given key in this dialog settings.booleangetBoolean(String key)Convenience API.doublegetDouble(String key)Convenience API.floatgetFloat(String key)Convenience API.intgetInt(String key)Convenience API.longgetLong(String key)Convenience API.StringgetName()Returns the IDialogSettings name.static IDialogSettingsgetOrCreateSection(IDialogSettings settings, String sectionName)Returns a section with the given name in the given dialog settings.IDialogSettingsgetSection(String sectionName)Returns the section with the given name in this dialog settings.IDialogSettings[]getSections()Returns all the sections in this dialog settings.voidload(Reader r)Load a dialog settings from a stream and fill the receiver with its content.voidload(String fileName)Load a dialog settings from a file and fill the receiver with its content.voidput(String key, boolean value)Convenience API.voidput(String key, double value)Convenience API.voidput(String key, float value)Convenience API.voidput(String key, int value)Convenience API.voidput(String key, long value)Convenience API.voidput(String key, String value)Adds the pairkey/valueto this dialog settings.voidput(String key, String[] value)Adds the pairkey/valueto this dialog settings.IDialogSettingsremoveSection(String sectionName)Remove a section by name in the receiver.voidremoveSection(IDialogSettings section)Remove a section in the receiver.voidsave(Writer writer)Save a dialog settings to a streamvoidsave(String fileName)Save a dialog settings to a file.
-
-
-
Constructor Detail
-
DialogSettings
public DialogSettings(String sectionName)
Create an empty dialog settings which loads and saves its content to a file. Use the methodsload(String)andstore(String)to load and store this dialog settings.- Parameters:
sectionName- the name of the section in the settings.
-
-
Method Detail
-
addNewSection
public IDialogSettings addNewSection(String sectionName)
Description copied from interface:IDialogSettingsCreate a new section in the receiver and return it.- Specified by:
addNewSectionin interfaceIDialogSettings- Parameters:
sectionName- the name of the new section- Returns:
- the new section
- See Also:
getOrCreateSection(IDialogSettings, String)
-
addSection
public void addSection(IDialogSettings section)
Description copied from interface:IDialogSettingsAdd a section in the receiver.- Specified by:
addSectionin interfaceIDialogSettings- Parameters:
section- the section to be added
-
removeSection
public void removeSection(IDialogSettings section)
Remove a section in the receiver. If the given section does not exist, nothing is done.- Parameters:
section- the section to be removed. Must not benull.- Since:
- 3.9
-
removeSection
public IDialogSettings removeSection(String sectionName)
Remove a section by name in the receiver. If the given section does not exist, nothing is done.- Parameters:
sectionName- the name of the section to be removed. Must not benull.- Returns:
- The dialog section removed, or
nullif it wasn't there. - Since:
- 3.9
-
get
public String get(String key)
Description copied from interface:IDialogSettingsReturns the value of the given key in this dialog settings.- Specified by:
getin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the value, or
nullif none
-
getArray
public String[] getArray(String key)
Description copied from interface:IDialogSettingsReturns the value, an array of strings, of the given key in this dialog settings.- Specified by:
getArrayin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the array of string, or
nullif none
-
getBoolean
public boolean getBoolean(String key)
Description copied from interface:IDialogSettingsConvenience API. Convert the value of the given key in this dialog settings to a boolean and return it.- Specified by:
getBooleanin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the boolean value, or
falseif none
-
getDouble
public double getDouble(String key) throws NumberFormatException
Description copied from interface:IDialogSettingsConvenience API. Convert the value of the given key in this dialog settings to a double and return it.- Specified by:
getDoublein interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the value coverted to double, or throws
NumberFormatExceptionif none - Throws:
NumberFormatException- if the string value does not contain a parsable number.- See Also:
Double.valueOf(java.lang.String)
-
getFloat
public float getFloat(String key) throws NumberFormatException
Description copied from interface:IDialogSettingsConvenience API. Convert the value of the given key in this dialog settings to a float and return it.- Specified by:
getFloatin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the value coverted to float, or throws
NumberFormatExceptionif none - Throws:
NumberFormatException- if the string value does not contain a parsable number.- See Also:
Float.valueOf(java.lang.String)
-
getInt
public int getInt(String key) throws NumberFormatException
Description copied from interface:IDialogSettingsConvenience API. Convert the value of the given key in this dialog settings to a int and return it.- Specified by:
getIntin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the value coverted to int, or throws
NumberFormatExceptionif none - Throws:
NumberFormatException- if the string value does not contain a parsable number.- See Also:
Integer.valueOf(java.lang.String)
-
getLong
public long getLong(String key) throws NumberFormatException
Description copied from interface:IDialogSettingsConvenience API. Convert the value of the given key in this dialog settings to a long and return it.- Specified by:
getLongin interfaceIDialogSettings- Parameters:
key- the key- Returns:
- the value coverted to long, or throws
NumberFormatExceptionif none - Throws:
NumberFormatException- if the string value does not contain a parsable number.- See Also:
Long.valueOf(java.lang.String)
-
getName
public String getName()
Description copied from interface:IDialogSettingsReturns the IDialogSettings name.- Specified by:
getNamein interfaceIDialogSettings- Returns:
- the name
-
getOrCreateSection
public static IDialogSettings getOrCreateSection(IDialogSettings settings, String sectionName)
Returns a section with the given name in the given dialog settings. If the section doesn't exist yet, then it is first created.- Parameters:
settings- the parent settingssectionName- the name of the section- Returns:
- the section
- Since:
- 3.7
-
getSection
public IDialogSettings getSection(String sectionName)
Description copied from interface:IDialogSettingsReturns the section with the given name in this dialog settings.- Specified by:
getSectionin interfaceIDialogSettings- Parameters:
sectionName- the key- Returns:
- IDialogSettings (the section), or
nullif none - See Also:
getOrCreateSection(IDialogSettings, String)
-
getSections
public IDialogSettings[] getSections()
Description copied from interface:IDialogSettingsReturns all the sections in this dialog settings.- Specified by:
getSectionsin interfaceIDialogSettings- Returns:
- the section, or
nullif none
-
load
public void load(Reader r)
Description copied from interface:IDialogSettingsLoad a dialog settings from a stream and fill the receiver with its content.- Specified by:
loadin interfaceIDialogSettings- Parameters:
r- a Reader specifying the stream where the settings are read from.
-
load
public void load(String fileName) throws IOException
Description copied from interface:IDialogSettingsLoad a dialog settings from a file and fill the receiver with its content.- Specified by:
loadin interfaceIDialogSettings- Parameters:
fileName- the name of the file the settings are read from.- Throws:
IOException
-
put
public void put(String key, String[] value)
Description copied from interface:IDialogSettingsAdds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, double value)
Description copied from interface:IDialogSettingsConvenience API. Converts the doublevalueto a string and adds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, float value)
Description copied from interface:IDialogSettingsConvenience API. Converts the floatvalueto a string and adds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, int value)
Description copied from interface:IDialogSettingsConvenience API. Converts the intvalueto a string and adds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, long value)
Description copied from interface:IDialogSettingsConvenience API. Converts the longvalueto a string and adds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, String value)
Description copied from interface:IDialogSettingsAdds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
put
public void put(String key, boolean value)
Description copied from interface:IDialogSettingsConvenience API. Converts the booleanvalueto a string and adds the pairkey/valueto this dialog settings.- Specified by:
putin interfaceIDialogSettings- Parameters:
key- the key.value- the value to be associated with thekey
-
save
public void save(Writer writer) throws IOException
Description copied from interface:IDialogSettingsSave a dialog settings to a stream- Specified by:
savein interfaceIDialogSettings- Parameters:
writer- a Writer specifying the stream the settings are written in.- Throws:
IOException
-
save
public void save(String fileName) throws IOException
Description copied from interface:IDialogSettingsSave a dialog settings to a file.- Specified by:
savein interfaceIDialogSettings- Parameters:
fileName- the name of the file the settings are written in.- Throws:
IOException
-
-