org.apache.maven.settings.io

Interface SettingsWriter

All Known Implementing Classes:

DefaultSettingsWriter

public interface SettingsWriter

Handles serialization of settings into some kind of textual format like XML.

Author:

Benjamin Bentmann

Method Summary

Modifier and Type	Method and Description
void	write(File output, Map<String,Object> options, Settings settings) Writes the supplied settings to the specified file.
void	write(OutputStream output, Map<String,Object> options, Settings settings) Writes the supplied settings to the specified byte stream.
void	write(Writer output, Map<String,Object> options, Settings settings) Writes the supplied settings to the specified character writer.

Method Detail

write

void write(File output,
           Map<String,Object> options,
           Settings settings)
    throws IOException

Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will be created automatically.

Parameters:

output - The file to serialize the settings to, must not be null.

options - The options to use for serialization, may be null to use the default values.

settings - The settings to serialize, must not be null.

Throws:

IOException - If the settings could not be serialized.

write

void write(Writer output,
           Map<String,Object> options,
           Settings settings)
    throws IOException

Writes the supplied settings to the specified character writer. The writer will be automatically closed before the method returns.

Parameters:

output - The writer to serialize the settings to, must not be null.

options - The options to use for serialization, may be null to use the default values.

settings - The settings to serialize, must not be null.

Throws:

IOException - If the settings could not be serialized.

write

void write(OutputStream output,
           Map<String,Object> options,
           Settings settings)
    throws IOException

Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the method returns.

Parameters:

output - The stream to serialize the settings to, must not be null.

options - The options to use for serialization, may be null to use the default values.

settings - The settings to serialize, must not be null.

Throws:

IOException - If the settings could not be serialized.