|
Eclipse Platform Release 3.6 |
|||||||||
| 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.
| Method Summary | |
|---|---|
IDialogSettings |
addNewSection(java.lang.String name)
Create a new section in the receiver and return it. |
void |
addSection(IDialogSettings section)
Add a section in the receiver. |
java.lang.String |
get(java.lang.String key)
Returns the value of the given key in this dialog settings. |
java.lang.String[] |
getArray(java.lang.String key)
Returns the value, an array of strings, of the given key in this dialog settings. |
boolean |
getBoolean(java.lang.String key)
Convenience API. |
double |
getDouble(java.lang.String key)
Convenience API. |
float |
getFloat(java.lang.String key)
Convenience API. |
int |
getInt(java.lang.String key)
Convenience API. |
long |
getLong(java.lang.String key)
Convenience API. |
java.lang.String |
getName()
Returns the IDialogSettings name. |
IDialogSettings |
getSection(java.lang.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(java.io.Reader reader)
Load a dialog settings from a stream and fill the receiver with its content. |
void |
load(java.lang.String fileName)
Load a dialog settings from a file and fill the receiver with its content. |
void |
put(java.lang.String key,
boolean value)
Convenience API. |
void |
put(java.lang.String key,
double value)
Convenience API. |
void |
put(java.lang.String key,
float value)
Convenience API. |
void |
put(java.lang.String key,
int value)
Convenience API. |
void |
put(java.lang.String key,
long value)
Convenience API. |
void |
put(java.lang.String key,
java.lang.String value)
Adds the pair key/value to this dialog settings. |
void |
put(java.lang.String key,
java.lang.String[] value)
Adds the pair key/value to this dialog settings. |
void |
save(java.lang.String fileName)
Save a dialog settings to a file. |
void |
save(java.io.Writer writer)
Save a dialog settings to a stream |
| Method Detail |
|---|
IDialogSettings addNewSection(java.lang.String name)
name - the name of the new section
void addSection(IDialogSettings section)
section - the section to be addedjava.lang.String get(java.lang.String key)
key - the key
null if nonejava.lang.String[] getArray(java.lang.String key)
key - the key
null if noneboolean getBoolean(java.lang.String key)
key - the key
false if none
double getDouble(java.lang.String key)
throws java.lang.NumberFormatException
key - the key
NumberFormatException if none
java.lang.NumberFormatException - if the string value does not contain a parsable number.Double.valueOf(java.lang.String)
float getFloat(java.lang.String key)
throws java.lang.NumberFormatException
key - the key
NumberFormatException if none
java.lang.NumberFormatException - if the string value does not contain a parsable number.Float.valueOf(java.lang.String)
int getInt(java.lang.String key)
throws java.lang.NumberFormatException
key - the key
NumberFormatException if none
java.lang.NumberFormatException - if the string value does not contain a parsable number.Integer.valueOf(java.lang.String)
long getLong(java.lang.String key)
throws java.lang.NumberFormatException
key - the key
NumberFormatException if none
java.lang.NumberFormatException - if the string value does not contain a parsable number.Long.valueOf(java.lang.String)java.lang.String getName()
IDialogSettings getSection(java.lang.String sectionName)
sectionName - the key
null if noneIDialogSettings[] getSections()
null if none
void load(java.io.Reader reader)
throws java.io.IOException
reader - a Reader specifying the stream where the settings are read
from.
java.io.IOException
void load(java.lang.String fileName)
throws java.io.IOException
fileName - the name of the file the settings are read from.
java.io.IOException
void put(java.lang.String key,
java.lang.String[] value)
key/value to this dialog settings.
key - the key.value - the value to be associated with the key
void put(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String key,
java.lang.String value)
key/value to this dialog settings.
key - the key.value - the value to be associated with the key
void put(java.lang.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(java.io.Writer writer)
throws java.io.IOException
writer - a Writer specifying the stream the settings are written in.
java.io.IOException
void save(java.lang.String fileName)
throws java.io.IOException
fileName - the name of the file the settings are written in.
java.io.IOException
|
Eclipse Platform Release 3.6 |
|||||||||
| 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, 2010. All rights reserved.