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