org.apache.maven.settings.io
Class DefaultSettingsWriter

java.lang.Object
  extended by org.apache.maven.settings.io.DefaultSettingsWriter
All Implemented Interfaces:
SettingsWriter

@Component(role=SettingsWriter.class)
public class DefaultSettingsWriter
extends Object
implements SettingsWriter

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

Author:
Benjamin Bentmann

Constructor Summary
DefaultSettingsWriter()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultSettingsWriter

public DefaultSettingsWriter()
Method Detail

write

public void write(File output,
                  Map<String,Object> options,
                  Settings settings)
           throws IOException
Description copied from interface: SettingsWriter
Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will be created automatically.

Specified by:
write in interface SettingsWriter
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

public void write(Writer output,
                  Map<String,Object> options,
                  Settings settings)
           throws IOException
Description copied from interface: SettingsWriter
Writes the supplied settings to the specified character writer. The writer will be automatically closed before the method returns.

Specified by:
write in interface SettingsWriter
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

public void write(OutputStream output,
                  Map<String,Object> options,
                  Settings settings)
           throws IOException
Description copied from interface: SettingsWriter
Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the method returns.

Specified by:
write in interface SettingsWriter
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.


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.