StringInputStream.java

package com.tazkiyatech.utils.streams;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;

import androidx.annotation.NonNull;

/**
 * Provides an easy method for reading in the contents of an {@link InputStream}
 * and converting it to a {@link String}.
 */
public class StringInputStream implements AutoCloseable {

    private static final int BUFFER_SIZE_BYTES = 2048;

    @NonNull private final InputStream inputStream;

    /**
     * Constructor.
     *
     * @param inputStream the {@link InputStream} instance to read in from.
     */
    public StringInputStream(@NonNull InputStream inputStream) {
        this.inputStream = inputStream;
    }

    /**
     * Reads in the contents of the {@link InputStream} instance that this class wraps.
     *
     * @return the value read in from the input stream.
     * @throws IOException if an I/O error occurs.
     */
    @NonNull
    public String read() throws IOException {
        try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream(BUFFER_SIZE_BYTES)) {
            byte[] buffer = new byte[BUFFER_SIZE_BYTES];
            int length;

            while ((length = inputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, length);
            }

            outputStream.flush();
            return outputStream.toString("UTF-8");
        }
    }

    @Override
    public void close() throws IOException {
        inputStream.close();
    }
}