SettingsWriter (Apache Maven 3.1.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.settings.io
Interface SettingsWriter

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

Method Summary
`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

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.

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.

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.