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.toolchain.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 import org.apache.maven.api.toolchain.PersistedToolchains;
27
28 /**
29 * Handles deserialization of toolchains from some kind of textual format like XML.
30 *
31 * @author Robert Scholte
32 * @since 3.3.0
33 */
34 public interface ToolchainsReader {
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.toolchains.io.isStrict";
41
42 /**
43 * Reads the toolchains from the specified file.
44 *
45 * @param input The file to deserialize the toolchains from, must not be {@code null}.
46 * @param options The options to use for deserialization, may be {@code null} to use the default values.
47 * @return The deserialized toolchains, never {@code null}.
48 * @throws IOException If the toolchains could not be deserialized.
49 * @throws ToolchainsParseException If the input format could not be parsed.
50 */
51 PersistedToolchains read(File input, Map<String, ?> options) throws IOException, ToolchainsParseException;
52
53 /**
54 * Reads the toolchains from the specified character reader. The reader will be automatically closed before the
55 * method returns.
56 *
57 * @param input The reader to deserialize the toolchains 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 toolchains, never {@code null}.
60 * @throws IOException If the toolchains could not be deserialized.
61 * @throws ToolchainsParseException If the input format could not be parsed.
62 */
63 PersistedToolchains read(Reader input, Map<String, ?> options) throws IOException, ToolchainsParseException;
64
65 /**
66 * Reads the toolchains from the specified byte stream. The stream will be automatically closed before the method
67 * returns.
68 *
69 * @param input The stream to deserialize the toolchains 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 toolchains, never {@code null}.
72 * @throws IOException If the toolchains could not be deserialized.
73 * @throws ToolchainsParseException If the input format could not be parsed.
74 */
75 PersistedToolchains read(InputStream input, Map<String, ?> options) throws IOException, ToolchainsParseException;
76 }