org.apache.maven.model.io

Class DefaultModelWriter

java.lang.Object

org.apache.maven.model.io.DefaultModelWriter

All Implemented Interfaces:

ModelWriter

@Named
 @Singleton
public class DefaultModelWriter
extends Object
implements ModelWriter

Handles serialization of a model into some kind of textual format like XML.

Author:

Benjamin Bentmann

Constructor Summary

Constructors

Constructor and Description
DefaultModelWriter()

Method Summary

Modifier and Type	Method and Description
void	write(File output, Map<String,Object> options, Model model) Writes the supplied model to the specified file.
void	write(OutputStream output, Map<String,Object> options, Model model) Writes the supplied model to the specified byte stream.
void	write(Writer output, Map<String,Object> options, Model model) Writes the supplied model 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

DefaultModelWriter

public DefaultModelWriter()

Method Detail

write

public void write(File output,
                  Map<String,Object> options,
                  Model model)
           throws IOException

Description copied from interface: ModelWriter

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

Specified by:

write in interface ModelWriter

Parameters:

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

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

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

Throws:

IOException - If the model could not be serialized.

write

public void write(Writer output,
                  Map<String,Object> options,
                  Model model)
           throws IOException

Description copied from interface: ModelWriter

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

Specified by:

write in interface ModelWriter

Parameters:

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

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

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

Throws:

IOException - If the model could not be serialized.

write

public void write(OutputStream output,
                  Map<String,Object> options,
                  Model model)
           throws IOException

Description copied from interface: ModelWriter

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

Specified by:

write in interface ModelWriter

Parameters:

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

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

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

Throws:

IOException - If the model could not be serialized.