Package org.apache.maven.settings.io
Interface SettingsReader
-
- All Known Implementing Classes:
DefaultSettingsReader
public interface SettingsReader
Handles deserialization of settings from some kind of textual format like XML.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
IS_STRICT
The key for the option to enable strict parsing.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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
-
IS_STRICT
static final java.lang.String IS_STRICT
The key for the option to enable strict parsing. This option is of typeBoolean
and defaults totrue
. Iffalse
, unknown elements will be ignored instead of causing a failure.- See Also:
- Constant Field Values
-
-
Method Detail
-
read
Settings read(java.io.File input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
Reads the settings from the specified file.- Parameters:
input
- The file to deserialize the settings from, must not benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized settings, never
null
. - Throws:
java.io.IOException
- If the settings could not be deserialized.SettingsParseException
- If the input format could not be parsed.
-
read
Settings read(java.io.Reader input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
Reads the settings from the specified character reader. The reader will be automatically closed before the method returns.- Parameters:
input
- The reader to deserialize the settings from, must not benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized settings, never
null
. - Throws:
java.io.IOException
- If the settings could not be deserialized.SettingsParseException
- If the input format could not be parsed.
-
read
Settings read(java.io.InputStream input, java.util.Map<java.lang.String,?> options) throws java.io.IOException, SettingsParseException
Reads the settings from the specified byte stream. The stream will be automatically closed before the method returns.- Parameters:
input
- The stream to deserialize the settings from, must not benull
.options
- The options to use for deserialization, may benull
to use the default values.- Returns:
- The deserialized settings, never
null
. - Throws:
java.io.IOException
- If the settings could not be deserialized.SettingsParseException
- If the input format could not be parsed.
-
-