package org.apache.maven.settings.io;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Map;
import org.apache.maven.settings.Settings;
Handles serialization of settings into some kind of textual format like XML.
Author: Benjamin Bentmann
/**
* Handles serialization of settings into some kind of textual format like XML.
*
* @author Benjamin Bentmann
*/
public interface SettingsWriter
{
Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will
be created automatically.
Params: - output – The file to serialize the settings to, must not be
null
. - options – The options to use for serialization, may be
null
to use the default values. - settings – The settings to serialize, must not be
null
.
Throws: - IOException – If the settings could not be serialized.
/**
* Writes the supplied settings to the specified file. Any non-existing parent directories of the output file will
* be created automatically.
*
* @param output The file to serialize the settings to, must not be {@code null}.
* @param options The options to use for serialization, may be {@code null} to use the default values.
* @param settings The settings to serialize, must not be {@code null}.
* @throws IOException If the settings could not be serialized.
*/
void write( File output, Map<String, Object> options, Settings settings )
throws IOException;
Writes the supplied settings to the specified character writer. The writer will be automatically closed before
the method returns.
Params: - output – The writer to serialize the settings to, must not be
null
. - options – The options to use for serialization, may be
null
to use the default values. - settings – The settings to serialize, must not be
null
.
Throws: - IOException – If the settings could not be serialized.
/**
* Writes the supplied settings to the specified character writer. The writer will be automatically closed before
* the method returns.
*
* @param output The writer to serialize the settings to, must not be {@code null}.
* @param options The options to use for serialization, may be {@code null} to use the default values.
* @param settings The settings to serialize, must not be {@code null}.
* @throws IOException If the settings could not be serialized.
*/
void write( Writer output, Map<String, Object> options, Settings settings )
throws IOException;
Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the
method returns.
Params: - output – The stream to serialize the settings to, must not be
null
. - options – The options to use for serialization, may be
null
to use the default values. - settings – The settings to serialize, must not be
null
.
Throws: - IOException – If the settings could not be serialized.
/**
* Writes the supplied settings to the specified byte stream. The stream will be automatically closed before the
* method returns.
*
* @param output The stream to serialize the settings to, must not be {@code null}.
* @param options The options to use for serialization, may be {@code null} to use the default values.
* @param settings The settings to serialize, must not be {@code null}.
* @throws IOException If the settings could not be serialized.
*/
void write( OutputStream output, Map<String, Object> options, Settings settings )
throws IOException;
}