Ready.java

// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0

package sop;

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

public abstract class Ready {

    /**
     * Write the data to the provided output stream.
     *
     * @param outputStream output stream
     * @throws IOException in case of an IO error
     */
    public abstract void writeTo(OutputStream outputStream) throws IOException;

    /**
     * Return the data as a byte array by writing it to a {@link ByteArrayOutputStream} first and then returning
     * the array.
     *
     * @return data as byte array
     * @throws IOException in case of an IO error
     */
    public byte[] getBytes() throws IOException {
        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
        writeTo(bytes);
        return bytes.toByteArray();
    }

    /**
     * Return an input stream containing the data.
     *
     * @return input stream
     * @throws IOException in case of an IO error
     */
    public InputStream getInputStream() throws IOException {
        return new ByteArrayInputStream(getBytes());
    }
}