|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDialogSettings
An interface to a storage mechanism for making dialog settings persistent. The store manages a collection of key/value pairs. The keys must be strings and the values can be either, strings or array of strings. Convenience API to convert primitive types to strings is provided.
DialogSettings
Method Summary | |
---|---|
IDialogSettings |
addNewSection(String name)
Create a new section in the receiver and return it. |
void |
addSection(IDialogSettings section)
Add a section in the receiver. |
String |
get(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. |
boolean |
getBoolean(String key)
Convenience API. |
double |
getDouble(String key)
Convenience API. |
float |
getFloat(String key)
Convenience API. |
int |
getInt(String key)
Convenience API. |
long |
getLong(String key)
Convenience API. |
String |
getName()
Returns the IDialogSettings name. |
IDialogSettings |
getSection(String sectionName)
Returns the section with the given name in this dialog settings. |
IDialogSettings[] |
getSections()
Returns all the sections in this dialog settings. |
void |
load(Reader reader)
Load a dialog settings from a stream and fill the receiver with its content. |
void |
load(String fileName)
Load a dialog settings from a file and fill the receiver with its content. |
void |
put(String key,
boolean value)
Convenience API. |
void |
put(String key,
double value)
Convenience API. |
void |
put(String key,
float value)
Convenience API. |
void |
put(String key,
int value)
Convenience API. |
void |
put(String key,
long value)
Convenience API. |
void |
put(String key,
String value)
Adds the pair key/value to this dialog settings. |
void |
put(String key,
String[] value)
Adds the pair key/value to this dialog settings. |
void |
save(String fileName)
Save a dialog settings to a file. |
void |
save(Writer writer)
Save a dialog settings to a stream |
Method Detail |
---|
IDialogSettings addNewSection(String name)
name
- the name of the new section
DialogSettings.getOrCreateSection(IDialogSettings, String)
void addSection(IDialogSettings section)
section
- the section to be addedString get(String key)
key
- the key
null
if noneString[] getArray(String key)
key
- the key
null
if noneboolean getBoolean(String key)
key
- the key
false
if nonedouble getDouble(String key) throws NumberFormatException
key
- the key
NumberFormatException
if none
NumberFormatException
- if the string value does not contain a parsable number.Double.valueOf(java.lang.String)
float getFloat(String key) throws NumberFormatException
key
- the key
NumberFormatException
if none
NumberFormatException
- if the string value does not contain a parsable number.Float.valueOf(java.lang.String)
int getInt(String key) throws NumberFormatException
key
- the key
NumberFormatException
if none
NumberFormatException
- if the string value does not contain a parsable number.Integer.valueOf(java.lang.String)
long getLong(String key) throws NumberFormatException
key
- the key
NumberFormatException
if none
NumberFormatException
- if the string value does not contain a parsable number.Long.valueOf(java.lang.String)
String getName()
IDialogSettings getSection(String sectionName)
sectionName
- the key
null
if noneDialogSettings.getOrCreateSection(IDialogSettings, String)
IDialogSettings[] getSections()
null
if nonevoid load(Reader reader) throws IOException
reader
- a Reader specifying the stream where the settings are read
from.
IOException
void load(String fileName) throws IOException
fileName
- the name of the file the settings are read from.
IOException
void put(String key, String[] value)
key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, double value)
value
to a string and
adds the pair key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, float value)
value
to a string and
adds the pair key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, int value)
value
to a string and
adds the pair key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, long value)
value
to a string and
adds the pair key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, String value)
key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void put(String key, boolean value)
value
to a string
and adds the pair key/value
to this dialog settings.
key
- the key.value
- the value to be associated with the key
void save(Writer writer) throws IOException
writer
- a Writer specifying the stream the settings are written in.
IOException
void save(String fileName) throws IOException
fileName
- the name of the file the settings are written in.
IOException
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.