|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SettingsReader
Handles deserialization of settings from some kind of textual format like XML.
Field Summary | |
---|---|
static java.lang.String |
IS_STRICT
The key for the option to enable strict parsing. |
Method Summary | |
---|---|
Settings |
read(java.io.File input,
java.util.Map<java.lang.String,?> options)
Reads the settings from the specified file. |
Settings |
read(java.io.InputStream input,
java.util.Map<java.lang.String,?> options)
Reads the settings from the specified byte stream. |
Settings |
read(java.io.Reader input,
java.util.Map<java.lang.String,?> options)
Reads the settings from the specified character reader. |
Field Detail |
---|
static final java.lang.String IS_STRICT
Boolean
and defaults to true
. If false
, unknown elements will be ignored instead of causing a failure.
Method Detail |
---|
Settings read(java.io.File input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
input
- The file to deserialize the settings from, must not be null
.options
- The options to use for deserialization, may be null
to use the default values.
null
.
java.io.IOException
- If the settings could not be deserialized.
SettingsParseException
- If the input format could not be parsed.Settings read(java.io.Reader input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
input
- The reader to deserialize the settings from, must not be null
.options
- The options to use for deserialization, may be null
to use the default values.
null
.
java.io.IOException
- If the settings could not be deserialized.
SettingsParseException
- If the input format could not be parsed.Settings read(java.io.InputStream input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
input
- The stream to deserialize the settings from, must not be null
.options
- The options to use for deserialization, may be null
to use the default values.
null
.
java.io.IOException
- If the settings could not be deserialized.
SettingsParseException
- If the input format could not be parsed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |