1 package org.apache.maven.toolchain.io;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.apache.maven.toolchain.model.PersistedToolchains;
23
24 import java.io.IOException;
25 import java.io.Writer;
26 import java.util.Map;
27
28 /**
29 * Handles serialization of toolchains into some kind of textual format like XML.
30 *
31 * @author Mike Mol
32 * @author Martin Kanters
33 */
34 public interface ToolchainsWriter
35 {
36
37 /**
38 * Writes the supplied toolchains to the specified character writer. The writer will be automatically closed before
39 * the method returns.
40 *
41 * @param output The writer to serialize the toolchains to, must not be {@code null}.
42 * @param options The options to use for serialization, may be {@code null} to use the default values.
43 * @param toolchains The toolchains to serialize, must not be {@code null}.
44 * @throws IOException If the toolchains could not be serialized.
45 */
46 void write( Writer output, Map<String, Object> options, PersistedToolchains toolchains )
47 throws IOException;
48 }