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 * @author Benjamin Bentmann
33 */
34 public interface ModelReader {
35
36 /**
37 * The key for the option to enable strict parsing. This option is of type {@link Boolean} and defaults to {@code
38 * true}. If {@code false}, unknown elements will be ignored instead of causing a failure.
39 */
40 String IS_STRICT = "org.apache.maven.model.io.isStrict";
41
42 /**
43 * The key for the option to enable tracking of line/column numbers. This option is of type
44 * {@link org.apache.maven.model.InputSource} and defaults to {@code null}. Providing an input source enables
45 * location tracking.
46 */
47 String INPUT_SOURCE = "org.apache.maven.model.io.inputSource";
48
49 /**
50 * The key for the option to provide a transformer context, which can be used to transform the input while reading
51 * to get an advanced version of the model.
52 */
53 String TRANSFORMER_CONTEXT = "transformerContext";
54
55 /**
56 * Reads the model from the specified file.
57 *
58 * @param input The file to deserialize the model from, must not be {@code null}.
59 * @param options The options to use for deserialization, may be {@code null} to use the default values.
60 * @return The deserialized model, never {@code null}.
61 * @throws IOException If the model could not be deserialized.
62 * @throws ModelParseException If the input format could not be parsed.
63 */
64 Model read(File input, Map<String, ?> options) throws IOException, ModelParseException;
65
66 /**
67 * Reads the model from the specified character reader. The reader will be automatically closed before the method
68 * returns.
69 *
70 * @param input The reader to deserialize the model from, must not be {@code null}.
71 * @param options The options to use for deserialization, may be {@code null} to use the default values.
72 * @return The deserialized model, never {@code null}.
73 * @throws IOException If the model could not be deserialized.
74 * @throws ModelParseException If the input format could not be parsed.
75 */
76 Model read(Reader input, Map<String, ?> options) throws IOException, ModelParseException;
77
78 /**
79 * Reads the model from the specified byte stream. The stream will be automatically closed before the method
80 * returns.
81 *
82 * @param input The stream to deserialize the model from, must not be {@code null}.
83 * @param options The options to use for deserialization, may be {@code null} to use the default values.
84 * @return The deserialized model, never {@code null}.
85 * @throws IOException If the model could not be deserialized.
86 * @throws ModelParseException If the input format could not be parsed.
87 */
88 Model read(InputStream input, Map<String, ?> options) throws IOException, ModelParseException;
89 }