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.OutputStream;
24 import java.io.Writer;
25 import java.util.Map;
26
27 import org.apache.maven.api.model.Model;
28
29 /**
30 * Handles serialization of a model into some kind of textual format like XML.
31 *
32 * @author Benjamin Bentmann
33 */
34 public interface ModelWriter {
35
36 /**
37 * Writes the supplied model to the specified file. Any non-existing parent directories of the output file will be
38 * created automatically.
39 *
40 * @param output The file to serialize the model to, must not be {@code null}.
41 * @param options The options to use for serialization, may be {@code null} to use the default values.
42 * @param model The model to serialize, must not be {@code null}.
43 * @throws IOException If the model could not be serialized.
44 */
45 void write(File output, Map<String, Object> options, Model model) throws IOException;
46
47 /**
48 * Writes the supplied model to the specified character writer. The writer will be automatically closed before the
49 * method returns.
50 *
51 * @param output The writer to serialize the model to, must not be {@code null}.
52 * @param options The options to use for serialization, may be {@code null} to use the default values.
53 * @param model The model to serialize, must not be {@code null}.
54 * @throws IOException If the model could not be serialized.
55 */
56 void write(Writer output, Map<String, Object> options, Model model) throws IOException;
57
58 /**
59 * Writes the supplied model to the specified byte stream. The stream will be automatically closed before the method
60 * returns.
61 *
62 * @param output The stream to serialize the model to, must not be {@code null}.
63 * @param options The options to use for serialization, may be {@code null} to use the default values.
64 * @param model The model to serialize, must not be {@code null}.
65 * @throws IOException If the model could not be serialized.
66 */
67 void write(OutputStream output, Map<String, Object> options, Model model) throws IOException;
68
69 /**
70 * Writes the supplied model to the specified file. Any non-existing parent directories of the output file will be
71 * created automatically.
72 *
73 * @param output The file to serialize the model to, must not be {@code null}.
74 * @param options The options to use for serialization, may be {@code null} to use the default values.
75 * @param model The model to serialize, must not be {@code null}.
76 * @throws IOException If the model could not be serialized.
77 */
78 void write(File output, Map<String, Object> options, org.apache.maven.model.Model model) throws IOException;
79
80 /**
81 * Writes the supplied model to the specified character writer. The writer will be automatically closed before the
82 * method returns.
83 *
84 * @param output The writer to serialize the model to, must not be {@code null}.
85 * @param options The options to use for serialization, may be {@code null} to use the default values.
86 * @param model The model to serialize, must not be {@code null}.
87 * @throws IOException If the model could not be serialized.
88 */
89 void write(Writer output, Map<String, Object> options, org.apache.maven.model.Model model) throws IOException;
90
91 /**
92 * Writes the supplied model to the specified byte stream. The stream will be automatically closed before the method
93 * returns.
94 *
95 * @param output The stream to serialize the model to, must not be {@code null}.
96 * @param options The options to use for serialization, may be {@code null} to use the default values.
97 * @param model The model to serialize, must not be {@code null}.
98 * @throws IOException If the model could not be serialized.
99 */
100 void write(OutputStream output, Map<String, Object> options, org.apache.maven.model.Model model) throws IOException;
101 }