net.openhft.lang.io.view.BytesOutputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lang Show documentation
Java Lang library for High Frequency Trading (Java 6+)
There is a newer version: 6.8.2
/*
 *     Copyright (C) 2015  higherfrequencytrading.com
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with this program.  If not, see .
 */

package net.openhft.lang.io.view;

import net.openhft.lang.io.Bytes;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;
import java.io.OutputStream;

/**
 * {@code OutputStream} view of {@link Bytes}. Writing data to this stream pushes {@linkplain
 * Bytes#position() position} of the underlying {@code Bytes}. On attempt of writing bytes beyond
 * backing {@code Bytes}' {@linkplain Bytes#limit() limit} {@link IOException} is thrown.
 *
 * {@code BytesOutputStream} are reusable, see {@link #bytes(Bytes)} method.
 *
 * @see Bytes#outputStream()
 * @see BytesInputStream
 */
public class BytesOutputStream extends OutputStream {
    private Bytes bytes;

    /**
     * Constructs a {@code BytesOutputStream} backed by the given {@code bytes}.
     *
     * @param bytes the {@code Bytes} backing the constructed {@code BytesOutputStream}
     */
    public BytesOutputStream(Bytes bytes) {
        this.bytes = bytes;
    }

    /**
     * Constructs a {@code BytesOutputStream} without backing {@code Bytes}, {@link #bytes(Bytes)}
     * method must be called before first actual use of the constructed {@code BytesOutputStream}
     * instance.
     */
    public BytesOutputStream() {}

    /**
     * Reassigns the underlying {@code Bytes} of this output stream.
     *
     * @param bytes new {@code Bytes} backing this {@code BytesOutputStream}
     * @return this {@code BytesOutputStream} object back
     */
    public BytesOutputStream bytes(Bytes bytes) {
        this.bytes = bytes;
        return this;
    }

    @Override
    public void close() {
        try {
            super.close();
        } catch (IOException e) {
            // never happens.
            throw new AssertionError(e);
        }
        // Don't close as we may want to continue'
    }

    private void checkNotClosed() throws IOException {
        if (bytes.isFinished())
            throw new IOException("Underlying bytes is closed");
    }

    private void checkAvailable(int n) throws IOException {
        if (n > bytes.remaining())
            throw new IOException("Not enough available space for writing " + n + " bytes");
    }

    @Override
    public void write(@NotNull byte[] b, int off, int len) throws IOException {
        if (b == null) {
            throw new NullPointerException();

        } else if ((off < 0) || (off > b.length) || (len < 0) ||
                ((off + len) > b.length) || ((off + len) < 0)) {
            throw new IndexOutOfBoundsException();

        } else if (len == 0) {
            return;
        }
        checkNotClosed();
        checkAvailable(len);
        bytes.write(b, off, len);
    }

    @Override
    public void write(int b) throws IOException {
        checkNotClosed();
        checkAvailable(1);
        bytes.writeUnsignedByte(b);
    }
}