Package org.apache.maven.model.io

Interface ModelReader

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String INPUT_SOURCE
      The key for the option to enable tracking of line/column numbers.
      static java.lang.String IS_STRICT
      The key for the option to enable strict parsing.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Model read​(java.io.File input, java.util.Map<java.lang.String,​?> options)
      Reads the model from the specified file.
      Model read​(java.io.InputStream input, java.util.Map<java.lang.String,​?> options)
      Reads the model from the specified byte stream.
      Model read​(java.io.Reader input, java.util.Map<java.lang.String,​?> options)
      Reads the model from the specified character reader.

    • Field Detail

      • IS_STRICT

        static final java.lang.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 java.lang.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​(java.io.File input,
           java.util.Map<java.lang.String,​?> options)
    throws java.io.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:
        java.io.IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.

      • read

        Model read​(java.io.Reader input,
           java.util.Map<java.lang.String,​?> options)
    throws java.io.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:
        java.io.IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.

      • read

        Model read​(java.io.InputStream input,
           java.util.Map<java.lang.String,​?> options)
    throws java.io.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:
        java.io.IOException - If the model could not be deserialized.
        ModelParseException - If the input format could not be parsed.