• Home
• com.swirlds
• swirlds-logging
• 0.52.2
• source code
• BufferedOutputStream.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.swirlds.logging.io.BufferedOutputStream Maven / Gradle / Ivy

/*
 * Copyright (C) 2024 Hedera Hashgraph, LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.swirlds.logging.io;

import edu.umd.cs.findbugs.annotations.NonNull;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.util.Objects;

/**
 * An OutputStream that uses {@link ByteBuffer} before writing to an underlying {@link OutputStream}
 */
public class BufferedOutputStream extends OutputStream {
    private final ByteBuffer buffer;
    private final OutputStream outputStream;

    /**
     * Creates a Writer that uses an internal {@link ByteBuffer} to buffer writes to the given {@code outputStream}.
     *
     * @param outputStream   the underlying {@link OutputStream} to write to
     * @param bufferCapacity the capacity of the buffer has to be grater than 0
     * @throws IllegalArgumentException in case {@code bufferCapacity} is less or equals to 0
     * @throws NullPointerException     in case {@code outputStream} is null
     */
    public BufferedOutputStream(@NonNull final OutputStream outputStream, final int bufferCapacity) {
        if (bufferCapacity <= 0) {
            throw new IllegalArgumentException("bufferCapacity must be > than 0");
        }
        this.outputStream = Objects.requireNonNull(outputStream, "outputStream must not be null");
        this.buffer = ByteBuffer.wrap(new byte[bufferCapacity]);
    }

    /**
     * if {@code length} is less than the remaining capacity of the buffer, buffers the {@code bytes} and eventually
     * writes it to the underlying stream. if the buffer is full or {@code length} is greater than buffers capacity,
     * writes bytes and the buffer content to the underlying output stream
     *
     * @param bytes information to write
     * @throws IOException in case there was an error writing to the underlying outputStream
     */
    @Override
    public synchronized void write(@NonNull final byte[] bytes, final int offset, final int length) throws IOException {
        internalWrite(bytes, offset, length);
    }

    /**
     * if {@code bytes} length is less than the remaining capacity of the buffer, buffers the {@code bytes} and
     * eventually writes it to the underlying stream. if the buffer is full or {@code buffer} length  is greater than
     * buffers capacity, writes bytes and the buffer content to the underlying output stream
     *
     * @param bytes information to write
     * @throws IOException in case there was an error writing to the underlying outputStream
     */
    @Override
    public synchronized void write(@NonNull final byte[] bytes) throws IOException {
        internalWrite(bytes, 0, bytes.length);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public synchronized void write(final int b) throws IOException {
        if (buffer.remaining() >= 1) {
            buffer.put((byte) b);
        } else {
            // if request length exceeds buffer capacity,
            // flush the buffer and write the data directly
            flush();
            outputStream.write(b);
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public synchronized void flush() throws IOException {
        flushBuffer(buffer);
        flushDestination();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void close() throws IOException {
        flush();
        outputStream.close();
    }

    private void internalWrite(final @NonNull byte[] bytes, final int offset, final int length) throws IOException {
        if (length >= buffer.capacity()) {
            // if request length exceeds buffer capacity, flush the buffer and write the data directly
            flush();
            writeToDestination(bytes, offset, length);
        } else {
            if (length > buffer.remaining()) {
                flush();
            }
            buffer.put(bytes, offset, length);
        }
    }

    private void writeToDestination(final byte[] bytes, final int offset, final int length) throws IOException {
        outputStream.write(bytes, offset, length);
    }

    private void flushDestination() throws IOException {
        outputStream.flush();
    }

    private void flushBuffer(final ByteBuffer buf) throws IOException {
        buf.flip();
        try {
            if (buf.remaining() > 0) {
                writeToDestination(buf.array(), buf.arrayOffset() + buf.position(), buf.remaining());
            }
        } finally {
            buf.clear();
        }
    }
}