public interface Settings
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 '$' '{' '[' ',' ']'| Modifier and Type | Method and Description | 
|---|---|
| Set<String> | getKeys()Return a set of keys of all properties loaded | 
| String | getSetting(String name)Get the value of an external override setting. | 
| String[] | getSettingArray(String name)Get the array of values for an external override setting. | 
| void | load(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. | 
| String | lookUp(String name)Look up the value for a property. | 
void load(InputStream in) throws IOException
, or
 new-line, so can span multiple lines without using a final \in - - Stream holding propertiesIOException - if name characters illegalvoid loadSystemDefaults()
                 throws ResourceConfigurationException
ResourceConfigurationException - wraps IOExceptionString lookUp(String name) throws ResourceConfigurationException
name - - name to look upResourceConfigurationException - if the value references an undefined propertySet<String> getKeys()
String getSetting(String name) throws ResourceConfigurationException
name - - the name of the parameterResourceConfigurationException - if the value references an undefined property, or the value is an arrayString[] getSettingArray(String name) throws ResourceConfigurationException
name - - the name of the parameterResourceConfigurationException - if the value references an undefined property, or the value is not an arrayCopyright © 2006–2022 The Apache Software Foundation. All rights reserved.