org.apache.maven.model.io
Interface ModelReader

All Known Subinterfaces:

ModelProcessor

All Known Implementing Classes:

DefaultModelProcessor, DefaultModelReader

public interface ModelReader

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

Author:

Benjamin Bentmann

Field Summary

static String	INPUT_SOURCE The key for the option to enable tracking of line/column numbers.
static String	IS_STRICT The key for the option to enable strict parsing.

Method Summary

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.

Field Detail

IS_STRICT

static final String IS_STRICT

The key for the option to enable strict parsing. This option is of type Boolean and defaults to true. If false, unknown elements will be ignored instead of causing a failure.

See Also:

Constant Field Values

INPUT_SOURCE

static final String INPUT_SOURCE

The key for the option to enable tracking of line/column numbers. This option is of type InputSource and defaults to null. Providing an input source enables location tracking.

See Also:

Constant Field Values

Method Detail

read

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

Reads the model from the specified file.

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.

ModelParseException - If the input format could not be parsed.

read

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

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

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.

ModelParseException - If the input format could not be parsed.

read

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

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

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.

ModelParseException - If the input format could not be parsed.