com.phloc.commons.io.IOutputStreamAndWriterProvider Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed 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.
*/
package com.phloc.commons.io;
import java.io.Writer;
import java.nio.charset.Charset;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* A callback interface to retrieve {@link Writer} objects based on
* InputStreams.
*
* @author Philip Helger
*/
public interface IOutputStreamAndWriterProvider extends IOutputStreamProvider
{
/**
* Get an {@link Writer} based on this output stream provider using the given
* charset.
*
* @param sCharset
* The charset to use. May not be null.
* @param eAppend
* Appending mode. May not be null.
* @return null if no output stream could be retrieved.
*/
@Nullable
@Deprecated
Writer getWriter (@Nonnull String sCharset, @Nonnull EAppend eAppend);
/**
* Get an {@link Writer} based on this output stream provider using the given
* charset.
*
* @param aCharset
* The charset to use. May not be null.
* @param eAppend
* Appending mode. May not be null.
* @return null if no output stream could be retrieved.
*/
@Nullable
Writer getWriter (@Nonnull Charset aCharset, @Nonnull EAppend eAppend);
}