View Javadoc

1   package org.apache.maven.settings.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.settings.Settings;
29  
30  /**
31   * Handles serialization of settings into some kind of textual format like XML.
32   * 
33   * @author Benjamin Bentmann
34   */
35  public interface SettingsWriter
36  {
37  
38      /**
39       * Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will
40       * be created automatically.
41       * 
42       * @param output The file to serialize the settings 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 settings The settings to serialize, must not be {@code null}.
45       * @throws IOException If the settings could not be serialized.
46       */
47      void write( File output, Map<String, Object> options, Settings settings )
48          throws IOException;
49  
50      /**
51       * Writes the supplied settings to the specified character writer. The writer will be automatically closed before
52       * the method returns.
53       * 
54       * @param output The writer to serialize the settings 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 settings The settings to serialize, must not be {@code null}.
57       * @throws IOException If the settings could not be serialized.
58       */
59      void write( Writer output, Map<String, Object> options, Settings settings )
60          throws IOException;
61  
62      /**
63       * Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the
64       * method returns.
65       * 
66       * @param output The stream to serialize the settings 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 settings The settings to serialize, must not be {@code null}.
69       * @throws IOException If the settings could not be serialized.
70       */
71      void write( OutputStream output, Map<String, Object> options, Settings settings )
72          throws IOException;
73  
74  }