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");
Constructor Summary
|
DialogSettings(String sectionName)
Create an empty dialog settings which loads and saves its
content to a file.
|
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
|
DialogSettings
public DialogSettings(String sectionName)
- Create an empty dialog settings which loads and saves its
content to a file.
Use the methods load(String) and store(String)
to load and store this dialog settings.
- Parameters:
- sectionName - the name of the section in the settings.
addNewSection
public IDialogSettings addNewSection(String sectionName)
- Description copied from interface: IDialogSettings
- Create a new section in the receiver and return it.
- Specified by:
- addNewSection in interface IDialogSettings
- Parameters:
- sectionName - the name of the new section
- Returns:
- the new section
addSection
public void addSection(IDialogSettings section)
- Description copied from interface: IDialogSettings
- Add a section in the receiver.
- Specified by:
- addSection in interface IDialogSettings
- Parameters:
- section - the section to be added
get
public String get(String key)
- Description copied from interface: IDialogSettings
- Returns the value of the given key in this dialog settings.
- Specified by:
- get in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the value, or null if none
getArray
public String[] getArray(String key)
- Description copied from interface: IDialogSettings
- Returns the value, an array of strings, of the given key in this dialog
settings.
- Specified by:
- getArray in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the array of string, or null if none
getBoolean
public boolean getBoolean(String key)
- Description copied from interface: IDialogSettings
- Convenience API. Convert the value of the given key in this dialog
settings to a boolean and return it.
- Specified by:
- getBoolean in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the boolean value, or false if none
getDouble
public double getDouble(String key)
throws NumberFormatException
- Description copied from interface: IDialogSettings
- Convenience API. Convert the value of the given key in this dialog
settings to a double and return it.
- Specified by:
- getDouble in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the value coverted to double, or throws
NumberFormatException if 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: IDialogSettings
- Convenience API. Convert the value of the given key in this dialog
settings to a float and return it.
- Specified by:
- getFloat in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the value coverted to float, or throws
NumberFormatException if 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: IDialogSettings
- Convenience API. Convert the value of the given key in this dialog
settings to a int and return it.
- Specified by:
- getInt in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the value coverted to int, or throws
NumberFormatException if 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: IDialogSettings
- Convenience API. Convert the value of the given key in this dialog
settings to a long and return it.
- Specified by:
- getLong in interface IDialogSettings
- Parameters:
- key - the key
- Returns:
- the value coverted to long, or throws
NumberFormatException if 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: IDialogSettings
- Returns the IDialogSettings name.
- Specified by:
- getName in interface IDialogSettings
- Returns:
- the name
getSection
public IDialogSettings getSection(String sectionName)
- Description copied from interface: IDialogSettings
- Returns the section with the given name in this dialog settings.
- Specified by:
- getSection in interface IDialogSettings
- Parameters:
- sectionName - the key
- Returns:
- IDialogSettings (the section), or null if none
getSections
public IDialogSettings[] getSections()
- Description copied from interface: IDialogSettings
- Returns all the sections in this dialog settings.
- Specified by:
- getSections in interface IDialogSettings
- Returns:
- the section, or null if none
load
public void load(Reader r)
- Description copied from interface: IDialogSettings
- Load a dialog settings from a stream and fill the receiver with its
content.
- Specified by:
- load in interface IDialogSettings
- 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: IDialogSettings
- Load a dialog settings from a file and fill the receiver with its
content.
- Specified by:
- load in interface IDialogSettings
- 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: IDialogSettings
- Adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
double value)
- Description copied from interface: IDialogSettings
- Convenience API. Converts the double value to a string and
adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
float value)
- Description copied from interface: IDialogSettings
- Convenience API. Converts the float value to a string and
adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
int value)
- Description copied from interface: IDialogSettings
- Convenience API. Converts the int value to a string and
adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
long value)
- Description copied from interface: IDialogSettings
- Convenience API. Converts the long value to a string and
adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
String value)
- Description copied from interface: IDialogSettings
- Adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
put
public void put(String key,
boolean value)
- Description copied from interface: IDialogSettings
- Convenience API. Converts the boolean value to a string
and adds the pair key/value to this dialog settings.
- Specified by:
- put in interface IDialogSettings
- Parameters:
- key - the key.
- value - the value to be associated with the key
save
public void save(Writer writer)
throws IOException
- Description copied from interface: IDialogSettings
- Save a dialog settings to a stream
- Specified by:
- save in interface IDialogSettings
- 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: IDialogSettings
- Save a dialog settings to a file.
- Specified by:
- save in interface IDialogSettings
- Parameters:
- fileName - the name of the file the settings are written in.
- Throws:
- IOException
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.