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.IOException;
22 import java.io.Writer;
23 import java.util.Map;
24
25 import org.apache.maven.toolchain.model.PersistedToolchains;
26
27 /**
28 * Handles serialization of toolchains into some kind of textual format like XML.
29 *
30 * @author Mike Mol
31 * @author Martin Kanters
32 */
33 public interface ToolchainsWriter {
34
35 /**
36 * Writes the supplied toolchains to the specified character writer. The writer will be automatically closed before
37 * the method returns.
38 *
39 * @param output The writer to serialize the toolchains 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 toolchains The toolchains to serialize, must not be {@code null}.
42 * @throws IOException If the toolchains could not be serialized.
43 */
44 void write(Writer output, Map<String, Object> options, PersistedToolchains toolchains) throws IOException;
45 }