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.settings.io;
20
21 import java.io.File;
22 import java.io.IOException;
23 import java.io.OutputStream;
24 import java.io.Writer;
25 import java.util.Map;
26 import org.apache.maven.api.settings.Settings;
27
28 /**
29 * Handles serialization of settings into some kind of textual format like XML.
30 *
31 * @author Benjamin Bentmann
32 */
33 public interface SettingsWriter {
34
35 /**
36 * Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will
37 * be created automatically.
38 *
39 * @param output The file to serialize the settings to, must not be {@code null}.
40 * @param options The options to use for serialization, may be {@code null} to use the default values.
41 * @param settings The settings to serialize, must not be {@code null}.
42 * @throws IOException If the settings could not be serialized.
43 */
44 void write(File output, Map<String, Object> options, Settings settings) throws IOException;
45
46 /**
47 * Writes the supplied settings to the specified character writer. The writer will be automatically closed before
48 * the method returns.
49 *
50 * @param output The writer to serialize the settings to, must not be {@code null}.
51 * @param options The options to use for serialization, may be {@code null} to use the default values.
52 * @param settings The settings to serialize, must not be {@code null}.
53 * @throws IOException If the settings could not be serialized.
54 */
55 void write(Writer output, Map<String, Object> options, Settings settings) throws IOException;
56
57 /**
58 * Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the
59 * method returns.
60 *
61 * @param output The stream to serialize the settings to, must not be {@code null}.
62 * @param options The options to use for serialization, may be {@code null} to use the default values.
63 * @param settings The settings to serialize, must not be {@code null}.
64 * @throws IOException If the settings could not be serialized.
65 */
66 void write(OutputStream output, Map<String, Object> options, Settings settings) throws IOException;
67 }