|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Settings
A Settings
object holds the properties used for external parameter overrides.
Similar to java.util.Properties but:
- supports UTF-8 (so \\uXXXX escapes are not needed or supported)
- keys must be valid Java identifiers (actually must not contain '=' ':' '}' or white-space)
- reverses priority in that duplicate entries are ignored, i.e. once set values cannot be changed
- multiple files can be loaded
- values can contain references to other values, e.g. name = .... ${key} ....
- arrays are represented as strings, e.g. '[elem1,elem2]', and can span multiple lines
- '\' can be used in values to escape '$' '{' '[' ',' ']'
Method Summary | |
---|---|
java.util.Set<java.lang.String> |
getKeys()
Return a set of keys of all properties loaded |
void |
load(java.io.InputStream in)
Load properties from an input stream. |
void |
loadSystemDefaults()
Load properties from the comma-separated list of files specified in the system property UimaExternalOverrides Files are loaded in order --- so in descending priority. |
java.lang.String |
lookUp(java.lang.String name)
Look up the value for a property. |
Method Detail |
---|
void load(java.io.InputStream in) throws java.io.IOException
,
or new-line, so
can span multiple lines without using a final \
in
- - Stream holding properties
java.io.IOException
- if name characters illegalvoid loadSystemDefaults() throws ResourceConfigurationException
ResourceConfigurationException
- wraps IOExceptionjava.lang.String lookUp(java.lang.String name) throws ResourceConfigurationException
name
- - name to look up
ResourceConfigurationException
- if the value references an undefined propertyjava.util.Set<java.lang.String> getKeys()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |