org.apache.maven.settings.io
Class DefaultSettingsReader

java.lang.Object
  org.apache.maven.settings.io.DefaultSettingsReader

All Implemented Interfaces:

SettingsReader

@Component(role=SettingsReader.class)
public class DefaultSettingsReader
extends Object
implements SettingsReader

Handles deserialization of settings from some kind of textual format like XML.

Author:

Benjamin Bentmann

Field Summary

Fields inherited from interface org.apache.maven.settings.io.SettingsReader

IS_STRICT

Constructor Summary

DefaultSettingsReader()

Method Summary

Settings	read(File input, Map<String,?> options) Reads the settings from the specified file.
Settings	read(InputStream input, Map<String,?> options) Reads the settings from the specified byte stream.
Settings	read(Reader input, Map<String,?> options) Reads the settings from the specified character reader.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSettingsReader

public DefaultSettingsReader()

Method Detail

read

public Settings read(File input,
                     Map<String,?> options)
              throws IOException

Description copied from interface: SettingsReader

Reads the settings from the specified file.

Specified by:

read in interface SettingsReader

Parameters:

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.

Returns:

The deserialized settings, never null.

Throws:

IOException - If the settings could not be deserialized.

SettingsParseException - If the input format could not be parsed.

read

public Settings read(Reader input,
                     Map<String,?> options)
              throws IOException

Description copied from interface: SettingsReader

Reads the settings from the specified character reader. The reader will be automatically closed before the method returns.

Specified by:

read in interface SettingsReader

Parameters:

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.

Returns:

The deserialized settings, never null.

Throws:

IOException - If the settings could not be deserialized.

SettingsParseException - If the input format could not be parsed.

read

public Settings read(InputStream input,
                     Map<String,?> options)
              throws IOException

Description copied from interface: SettingsReader

Reads the settings from the specified byte stream. The stream will be automatically closed before the method returns.

Specified by:

read in interface SettingsReader

Parameters:

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.

Returns:

The deserialized settings, never null.

Throws:

IOException - If the settings could not be deserialized.

SettingsParseException - If the input format could not be parsed.