org.abego.commons.io.OutputStreamUtil Maven / Gradle / Ivy

Go to download
/*
 * MIT License
 *
 * Copyright (c) 2020 Udo Borkowski, ([email protected])
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.abego.commons.io;

import org.abego.commons.lang.exception.MustNotInstantiateException;

import java.io.OutputStream;
import java.io.PrintWriter;
import java.nio.charset.Charset;

import static org.abego.commons.io.PrintWriterUtil.printWriter;

public final class OutputStreamUtil {

    OutputStreamUtil() {
        throw new MustNotInstantiateException();
    }

    /**
     * Write the {@code text} to the {@code outputStream} using {@code charset}.
     */
    public static void write(
            final String text,
            OutputStream outputStream,
            final Charset charset) {

        try (PrintWriter writer = printWriter(outputStream, charset)) {
            writer.write(text);
        }
    }

    /**
     * Returns an {@link OutputStream} that fails with an
     * {@link IllegalStateException} when writing to it.
     *
     * @param messageOnWrite the message of the exception
     */
    public static OutputStream getOutputStreamFailingOnWrite(String messageOnWrite) {
        return new OutputStream() {
            @Override
            public void write(int b) {
                throw new IllegalStateException(messageOnWrite);
            }
        };
    }


}