|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IValueMap
A Map
interface that holds values, parses String
s, and exposes a
variety of convenience methods.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Method Summary | |
---|---|
void |
clear()
|
boolean |
getBoolean(java.lang.String key)
Retrieves a boolean value by key. |
java.lang.CharSequence |
getCharSequence(java.lang.String key)
Retrieves a CharSequence by key. |
double |
getDouble(java.lang.String key)
Retrieves a double value by key. |
double |
getDouble(java.lang.String key,
double defaultValue)
Retrieves a double value by key, using a default value if not found. |
Duration |
getDuration(java.lang.String key)
Retrieves a Duration by key. |
int |
getInt(java.lang.String key)
Retrieves an int value by key. |
int |
getInt(java.lang.String key,
int defaultValue)
Retrieves an int value by key, using a default value if not found. |
java.lang.String |
getKey(java.lang.String key)
Provided that the hash key is a String and you need to access the value
ignoring the key's case (upper- or lowercase letters), then you may use this method to get
the correct writing. |
long |
getLong(java.lang.String key)
Retrieves a long value by key. |
long |
getLong(java.lang.String key,
long defaultValue)
Retrieves a long value by key, using a default value if not found. |
java.lang.String |
getString(java.lang.String key)
Retrieves a String by key. |
java.lang.String |
getString(java.lang.String key,
java.lang.String defaultValue)
Retrieves a String by key, using a default value if not found. |
java.lang.String[] |
getStringArray(java.lang.String key)
Retrieves a String array by key. |
StringValue |
getStringValue(java.lang.String key)
Retrieves a StringValue object by key. |
Time |
getTime(java.lang.String key)
Retrieves a Time object by key. |
boolean |
isImmutable()
Returns whether or not this IValueMap is immutable. |
IValueMap |
makeImmutable()
Makes this IValueMap immutable by changing the underlying map representation
to a Collections.unmodifiableMap . |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
|
void |
putAll(java.util.Map map)
|
java.lang.Object |
remove(java.lang.Object key)
|
Methods inherited from interface java.util.Map |
---|
containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, size, values |
Method Detail |
---|
void clear()
clear
in interface java.util.Map
Map.clear()
boolean getBoolean(java.lang.String key) throws StringValueConversionException
boolean
value by key.
key
- the key
StringValueConversionException
double getDouble(java.lang.String key) throws StringValueConversionException
double
value by key.
key
- the key
StringValueConversionException
double getDouble(java.lang.String key, double defaultValue) throws StringValueConversionException
double
value by key, using a default value if not found.
key
- the keydefaultValue
- value to use if no value is in this IValueMap
StringValueConversionException
Duration getDuration(java.lang.String key) throws StringValueConversionException
Duration
by key.
key
- the key
Duration
value
StringValueConversionException
int getInt(java.lang.String key) throws StringValueConversionException
int
value by key.
key
- the key
StringValueConversionException
int getInt(java.lang.String key, int defaultValue) throws StringValueConversionException
int
value by key, using a default value if not found.
key
- the keydefaultValue
- value to use if no value is in this IValueMap
StringValueConversionException
long getLong(java.lang.String key) throws StringValueConversionException
long
value by key.
key
- the key
StringValueConversionException
long getLong(java.lang.String key, long defaultValue) throws StringValueConversionException
long
value by key, using a default value if not found.
key
- the keydefaultValue
- value to use if no value in this IValueMap
StringValueConversionException
java.lang.String getString(java.lang.String key, java.lang.String defaultValue)
String
by key, using a default value if not found.
key
- the keydefaultValue
- default value to return if value is null
String
java.lang.String getString(java.lang.String key)
String
by key.
key
- the key
String
java.lang.CharSequence getCharSequence(java.lang.String key)
CharSequence
by key.
key
- the key
CharSequence
java.lang.String[] getStringArray(java.lang.String key)
String
array by key. If the value was a String[]
it
will be returned directly. If it was a String
it will be converted to a
String
array of length one. If it was an array of another type, a
String
array will be made and each element will be converted to a
String
.
key
- the key
String
array of that keyStringValue getStringValue(java.lang.String key)
StringValue
object by key.
key
- the key
StringValue
objectTime getTime(java.lang.String key) throws StringValueConversionException
Time
object by key.
key
- the key
Time
object
StringValueConversionException
boolean isImmutable()
IValueMap
is immutable.
IValueMap
is immutableIValueMap makeImmutable()
IValueMap
immutable by changing the underlying map representation
to a Collections.unmodifiableMap
. After calling this method, any attempt to
modify this IValueMap
will result in a RuntimeException
being
thrown by the Collections
framework.
IValueMap
java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
Map.put(Object, Object)
void putAll(java.util.Map map)
putAll
in interface java.util.Map
Map.putAll(java.util.Map)
java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map
Map.remove(java.lang.Object)
java.lang.String getKey(java.lang.String key)
String
and you need to access the value
ignoring the key's case (upper- or lowercase letters), then you may use this method to get
the correct writing.
key
- the key
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |