View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.model.io;
20  
21  import java.io.File;
22  import java.io.IOException;
23  import java.io.InputStream;
24  import java.io.Reader;
25  import java.util.Map;
26  
27  import org.apache.maven.model.Model;
28  
29  /**
30   * Handles deserialization of a model from some kind of textual format like XML.
31   *
32   */
33  public interface ModelReader {
34  
35      /**
36       * The key for the option to enable strict parsing. This option is of type {@link Boolean} and defaults to {@code
37       * true}. If {@code false}, unknown elements will be ignored instead of causing a failure.
38       */
39      String IS_STRICT = "org.apache.maven.model.io.isStrict";
40  
41      /**
42       * The key for the option to enable tracking of line/column numbers. This option is of type
43       * {@link org.apache.maven.model.InputSource} and defaults to {@code null}. Providing an input source enables
44       * location tracking.
45       */
46      String INPUT_SOURCE = "org.apache.maven.model.io.inputSource";
47  
48      /**
49       * Name of the property used to store the project's root directory to use with
50       * XInclude support.
51       */
52      String ROOT_DIRECTORY = "rootDirectory";
53  
54      /**
55       * Reads the model from the specified file.
56       *
57       * @param input The file to deserialize the model from, must not be {@code null}.
58       * @param options The options to use for deserialization, may be {@code null} to use the default values.
59       * @return The deserialized model, never {@code null}.
60       * @throws IOException If the model could not be deserialized.
61       * @throws ModelParseException If the input format could not be parsed.
62       */
63      Model read(File input, Map<String, ?> options) throws IOException, ModelParseException;
64  
65      /**
66       * Reads the model from the specified character reader. The reader will be automatically closed before the method
67       * returns.
68       *
69       * @param input The reader to deserialize the model from, must not be {@code null}.
70       * @param options The options to use for deserialization, may be {@code null} to use the default values.
71       * @return The deserialized model, never {@code null}.
72       * @throws IOException If the model could not be deserialized.
73       * @throws ModelParseException If the input format could not be parsed.
74       */
75      Model read(Reader input, Map<String, ?> options) throws IOException, ModelParseException;
76  
77      /**
78       * Reads the model from the specified byte stream. The stream will be automatically closed before the method
79       * returns.
80       *
81       * @param input The stream to deserialize the model from, must not be {@code null}.
82       * @param options The options to use for deserialization, may be {@code null} to use the default values.
83       * @return The deserialized model, never {@code null}.
84       * @throws IOException If the model could not be deserialized.
85       * @throws ModelParseException If the input format could not be parsed.
86       */
87      Model read(InputStream input, Map<String, ?> options) throws IOException, ModelParseException;
88  }