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.nio.file.Path;
26 import java.util.Map;
27
28 import org.apache.maven.model.Model;
29
30 /**
31 * Handles deserialization of a model from some kind of textual format like XML.
32 *
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 * Name of the property used to store the project's root directory to use with
51 * XInclude support.
52 */
53 String ROOT_DIRECTORY = "rootDirectory";
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 * @deprecated Use {@link #read(Path, Map)} instead.
64 */
65 @Deprecated
66 Model read(File input, Map<String, ?> options) throws IOException, ModelParseException;
67
68 /**
69 * Reads the model from the specified file.
70 *
71 * @param input The file to deserialize the model from, must not be {@code null}.
72 * @param options The options to use for deserialization, may be {@code null} to use the default values.
73 * @return The deserialized model, never {@code null}.
74 * @throws IOException If the model could not be deserialized.
75 * @throws ModelParseException If the input format could not be parsed.
76 */
77 Model read(Path input, Map<String, ?> options) throws IOException, ModelParseException;
78
79 /**
80 * Reads the model from the specified character reader. The reader will be automatically closed before the method
81 * returns.
82 *
83 * @param input The reader to deserialize the model from, must not be {@code null}.
84 * @param options The options to use for deserialization, may be {@code null} to use the default values.
85 * @return The deserialized model, never {@code null}.
86 * @throws IOException If the model could not be deserialized.
87 * @throws ModelParseException If the input format could not be parsed.
88 */
89 Model read(Reader input, Map<String, ?> options) throws IOException, ModelParseException;
90
91 /**
92 * Reads the model from the specified byte stream. The stream will be automatically closed before the method
93 * returns.
94 *
95 * @param input The stream to deserialize the model from, must not be {@code null}.
96 * @param options The options to use for deserialization, may be {@code null} to use the default values.
97 * @return The deserialized model, never {@code null}.
98 * @throws IOException If the model could not be deserialized.
99 * @throws ModelParseException If the input format could not be parsed.
100 */
101 Model read(InputStream input, Map<String, ?> options) throws IOException, ModelParseException;
102 }