|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigRO
Interface implements only access functions for Config
objects.
In addition, it implements the TreeNode
and
Iterable
interface.
Method Summary | |
---|---|
boolean |
containsKey(String key)
Checks if this key for a particular type is in this Config. |
void |
copyTo(ConfigWO config)
Copies this Config into a write-only one. |
boolean |
getBoolean(String key)
Return boolean for key. |
boolean |
getBoolean(String key,
boolean def)
Return boolean for key or the default value if not available. |
boolean[] |
getBooleanArray(String key)
Return a boolean array for key which can be null. |
boolean[] |
getBooleanArray(String key,
boolean... def)
Return a boolean array which can be null for key, or the default value if not available. |
byte |
getByte(String key)
Return byte for key. |
byte |
getByte(String key,
byte def)
Return byte for key. |
byte[] |
getByteArray(String key)
Return byte array which can be null for key. |
byte[] |
getByteArray(String key,
byte... def)
Return byte array which can be null for key, or the default value if not available. |
char |
getChar(String key)
Return char for key. |
char |
getChar(String key,
char def)
Return char for key or the default value if not available. |
char[] |
getCharArray(String key)
Return char array which can be null for key. |
char[] |
getCharArray(String key,
char... def)
Return char array which can be null for key, or the default array if the key is not available. |
Config |
getConfig(String key)
Returns a Config for the given key. |
DataCell |
getDataCell(String key)
Return DataCell for key. |
DataCell |
getDataCell(String key,
DataCell def)
Return a DataCell which can be null, or the default value if the key is not available. |
DataCell[] |
getDataCellArray(String key)
Return DataCell array. |
DataCell[] |
getDataCellArray(String key,
DataCell... def)
Return DataCell array which can be null for key, or the default array if the key is not available. |
DataType |
getDataType(String key)
Return DataType for key. |
DataType |
getDataType(String key,
DataType def)
Return a DataType elements or null for key, or the default value if not available. |
DataType[] |
getDataTypeArray(String key)
Returns an array of DataType objects which can be null. |
DataType[] |
getDataTypeArray(String key,
DataType... v)
Returns the array of DataType objects for the given key or if not available the given array. |
double |
getDouble(String key)
Return double for key. |
double |
getDouble(String key,
double def)
Return double for key or the default value if not available. |
double[] |
getDoubleArray(String key)
Return double array for key or the default value if not available. |
double[] |
getDoubleArray(String key,
double... def)
Return double array which can be null for key, or the default array if the key is not available. |
float |
getFloat(String key)
Return float for key. |
float |
getFloat(String key,
float def)
Return float for key or the default value if not available. |
float[] |
getFloatArray(String key)
Return float array for key or the default value if not available. |
float[] |
getFloatArray(String key,
float... def)
Return float array which can be null for key, or the default array if the key is not available. |
int |
getInt(String key)
Return int for key. |
int |
getInt(String key,
int def)
Return int for key or the default value if not available. |
int[] |
getIntArray(String key)
Return int array which can be null for key, or the default array if the key is not available. |
int[] |
getIntArray(String key,
int... def)
Return int array which can be null for key, or the default array if the key is not available. |
String |
getKey()
|
long |
getLong(String key)
Return long for key. |
long |
getLong(String key,
long def)
Return long value for key or the default if the key is not available. |
long[] |
getLongArray(String key)
Return a long array which can be null for key, or the default value if not available. |
long[] |
getLongArray(String key,
long... def)
Return long array which can be null for key, or the default array if the key is not available. |
RowKey |
getRowKey(String key)
Return RowKey for key. |
RowKey |
getRowKey(String key,
RowKey def)
Return a RowKey which can be null, or the default value if
the key is not available. |
RowKey[] |
getRowKeyArray(String key)
Return RowKey array for the given key. |
RowKey[] |
getRowKeyArray(String key,
RowKey... def)
Return a RowKey array which can be null, or the default
value if the key is not available. |
short |
getShort(String key)
Return short for key. |
short |
getShort(String key,
short def)
Return short value for key or the default if the key is not available. |
short[] |
getShortArray(String key)
Return a short array which can be null for key, or the default value if not available. |
short[] |
getShortArray(String key,
short... def)
Return short array which can be null for key, or the default array if the key is not available. |
String |
getString(String key)
Return String for key. |
String |
getString(String key,
String def)
Return String object which can be null, or the default array if the key is not available. |
String[] |
getStringArray(String key)
Return String array which can be null for key. |
String[] |
getStringArray(String key,
String... def)
Return String array which can be null for key, or the default array if the key is not available. |
Iterator<String> |
iterator()
|
Set<String> |
keySet()
Returns an unmodifiable Set of keys in this Config. |
void |
saveToXML(OutputStream os)
Saves this Config into the given stream in XML format. |
Methods inherited from interface javax.swing.tree.TreeNode |
---|
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf |
Method Detail |
---|
Config getConfig(String key) throws InvalidSettingsException
Config
for the given key.
key
- The identifier for the Config
.
Config
object.
InvalidSettingsException
- If the Config could not be accessed.void saveToXML(OutputStream os) throws IOException
Config
into the given stream in XML format.
os
- The stream to write into.
IOException
- If an io exception occurs during writing.void copyTo(ConfigWO config)
Config
into a write-only one.
config
- The Config
to write this to.String getKey()
Config
.int getInt(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.double getDouble(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.char getChar(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.short getShort(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.long getLong(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.byte getByte(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.String getString(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.DataCell getDataCell(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.RowKey getRowKey(String key) throws InvalidSettingsException
RowKey
for key.
key
- the identifier used to store the RowKey
before
RowKey
InvalidSettingsException
- if the key is not availableRowKey[] getRowKeyArray(String key) throws InvalidSettingsException
RowKey
array for the given key.
key
- the identifier used to store the RowKey
array
before
RowKey
array
InvalidSettingsException
- if the key is not availableDataType getDataType(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.Set<String> keySet()
boolean containsKey(String key)
key
- The key.
null
or not available.boolean getBoolean(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.int getInt(String key, int def)
key
- The key.def
- Returned if no value available for the given key.
int[] getIntArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.int[] getIntArray(String key, int... def)
key
- The key.def
- The default array returned if the key is not available.
double getDouble(String key, double def)
key
- The key.def
- Returned if no value available for the given key.
double[] getDoubleArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.double[] getDoubleArray(String key, double... def)
key
- The key.def
- The default array returned if the key is not available.
float getFloat(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.float getFloat(String key, float def)
key
- The key.def
- Returned if no value available for the given key.
float[] getFloatArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.float[] getFloatArray(String key, float... def)
key
- The key.def
- The default array returned if the key is not available.
char getChar(String key, char def)
key
- The key.def
- Returned if no value available for the given key.
char[] getCharArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the the key is not available.byte[] getByteArray(String key, byte... def)
key
- The key.def
- Returned if no value available for the given key.
byte[] getByteArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the the key is not available.byte getByte(String key, byte def)
key
- The key.def
- Returned if no value available for the given key.
short[] getShortArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.short[] getShortArray(String key, short... def)
key
- The key.def
- The default array returned if the key is not available.
long[] getLongArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.long[] getLongArray(String key, long... def)
key
- The key.def
- The default array returned if the key is not available.
short getShort(String key, short def)
key
- The key.def
- The default values returned if the key is not available.
long getLong(String key, long def)
key
- The key.def
- The default values returned if the key is not available.
char[] getCharArray(String key, char... def)
key
- The key.def
- The default array returned if the key is not available.
boolean getBoolean(String key, boolean def)
key
- The key.def
- Returned if no value available for the given key.
boolean[] getBooleanArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.boolean[] getBooleanArray(String key, boolean... def)
key
- The key.def
- Returned if no value available for the given key.
String getString(String key, String def)
key
- The key.def
- The default String returned if the key is not available.
String[] getStringArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the key is not available.String[] getStringArray(String key, String... def)
key
- The key.def
- The default array returned if the key is not available.
DataCell getDataCell(String key, DataCell def)
key
- The key.def
- The default value, returned id the key is not available.
RowKey getRowKey(String key, RowKey def)
RowKey
which can be null, or the default value if
the key is not available.
key
- identifier used to store the RowKey
beforedef
- default value, returned if the key is not available
RowKey
RowKey[] getRowKeyArray(String key, RowKey... def)
RowKey
array which can be null, or the default
value if the key is not available.
key
- identifier used to store the RowKey
array beforedef
- default value, returned if the key is not available
RowKey
arrayDataType getDataType(String key, DataType def)
key
- The key.def
- Returned if no value available for the given key.
DataCell[] getDataCellArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- If the the key is not available.DataCell[] getDataCellArray(String key, DataCell... def)
key
- The key.def
- The default array returned if the key is not available.
DataType[] getDataTypeArray(String key) throws InvalidSettingsException
key
- The key.
InvalidSettingsException
- The the object is not available for the
given key.DataType[] getDataTypeArray(String key, DataType... v)
key
- The key.v
- The default array, returned if no entry available for the key.
Iterator<String> iterator()
iterator
in interface Iterable<String>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |