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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of abego-commons-base Show documentation
There is a newer version: 1.1.0
/*
 * 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 org.abego.commons.util.ScannerUtil;

import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Scanner;

import static java.nio.file.Files.copy;
import static java.nio.file.StandardCopyOption.REPLACE_EXISTING;
import static org.abego.commons.io.FileUtil.runIOCode;

public final class InputStreamUtil {

    InputStreamUtil() {
        throw new MustNotInstantiateException();
    }

    // --- Factories ---

    public static InputStream newInputStream(String text, Charset charset) {
        return new ByteArrayInputStream(text.getBytes(charset));
    }

    public static InputStream newInputStream(String text) {
        return newInputStream(text, StandardCharsets.UTF_8);
    }

    // --- Queries ---

    public static String textOf(InputStream inputStream) {
        return textOf(inputStream, StandardCharsets.UTF_8);
    }

    public static String textOf(InputStream inputStream, String charsetName) {
        return ScannerUtil.textOf(() -> new Scanner(inputStream, charsetName));
    }

    public static String textOf(InputStream inputStream, Charset charset) {
        return textOf(inputStream, charset.name());
    }

    // --- Commands ---

    /**
     * Write the content of the inputStream to file.
     */
    public static void write(InputStream inputStream, File file) {
        runIOCode(() -> copy(inputStream, file.toPath(), REPLACE_EXISTING));
    }

}