Package org.apache.maven.model.io

Class DefaultModelReader

java.lang.Object

org.apache.maven.model.io.DefaultModelReader

All Implemented Interfaces:

ModelReader

@Named
@Singleton
public class DefaultModelReader
extends Object
implements ModelReader

Handles deserialization of a model from some kind of textual format like XML.

Field Summary

Fields inherited from interface org.apache.maven.model.io.ModelReader

INPUT_SOURCE, IS_STRICT, ROOT_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
DefaultModelReader(ModelSourceTransformer transformer)

Method Summary

Modifier and Type	Method	Description
Model	read(File input, Map<String,?> options)	Reads the model from the specified file.
Model	read(InputStream input, Map<String,?> options)	Reads the model from the specified byte stream.
Model	read(Reader input, Map<String,?> options)	Reads the model from the specified character reader.
Model	read(Path path, Map<String,?> options)	Reads the model from the specified file.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultModelReader

@Inject
public DefaultModelReader(ModelSourceTransformer transformer)

Method Details

read

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

Description copied from interface: ModelReader

Reads the model from the specified file.

Specified by:

read in interface ModelReader

Parameters:

input - The file to deserialize the model from, must not be null.

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

Returns:

The deserialized model, never null.

Throws:

IOException - If the model could not be deserialized.

read

public Model read(Path path,
 Map<String,?> options)
           throws IOException

Description copied from interface: ModelReader

Reads the model from the specified file.

Specified by:

read in interface ModelReader

Parameters:

path - The file to deserialize the model from, must not be null.

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

Returns:

The deserialized model, never null.

Throws:

IOException - If the model could not be deserialized.

read

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

Description copied from interface: ModelReader

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

Specified by:

read in interface ModelReader

Parameters:

input - The reader to deserialize the model from, must not be null.

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

Returns:

The deserialized model, never null.

Throws:

IOException - If the model could not be deserialized.

read

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

Description copied from interface: ModelReader

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

Specified by:

read in interface ModelReader

Parameters:

input - The stream to deserialize the model from, must not be null.

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

Returns:

The deserialized model, never null.

Throws:

IOException - If the model could not be deserialized.