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