org.spf4j.io.BufferedOutputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation
A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...
The newest version!
/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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 org.spf4j.io;

import edu.umd.cs.findbugs.annotations.CleanupObligation;
import edu.umd.cs.findbugs.annotations.DischargesObligation;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.io.OutputStream;
import org.spf4j.base.Base64;
import org.spf4j.recyclable.SizedRecyclingSupplier;
import org.spf4j.recyclable.impl.ArraySuppliers;

/**
 * Better that the JDK outputstream, no exception swallowing...
 * and ability to recycle underlying byte array.
 * @author zoly
 */
@CleanupObligation
public final class BufferedOutputStream extends OutputStream {

    private byte[] buf;
    private final int length;
    private final OutputStream os;
    private final SizedRecyclingSupplier bufferProvider;

    private int count;

    public BufferedOutputStream(final OutputStream out) {
        this(out, 8192);
    }

    public BufferedOutputStream(final OutputStream out, final int size) {
        this(out, size, ArraySuppliers.Bytes.JAVA_NEW);
    }

    @SuppressFBWarnings("EI_EXPOSE_REP2")
    public BufferedOutputStream(final OutputStream out, final int size,
            final SizedRecyclingSupplier bufferProvider) {
        if (size <= 0) {
            throw new IllegalArgumentException("Buffer size <= 0 : " + size);
        }
        this.bufferProvider = bufferProvider;
        buf = bufferProvider.get(size);
        length = size;
        this.os = out;
    }

    private void flushBuffer() throws IOException {
        if (count > 0) {
            os.write(buf, 0, count);
            count = 0;
        }
    }

    @Override
    public synchronized void write(final int b) throws IOException {
        if (buf == null) {
            throw new IOException("Stream closed " + os);
        }
        if (count >= length) {
            flushBuffer();
        }
        buf[count++] = (byte) b;
    }

    @Override
    public synchronized void write(final byte[] b, final int off, final int len) throws IOException {
        if (buf == null) {
            throw new IOException("Stream closed " + os);
        }
        if (len >= length) {
            flushBuffer();
            os.write(b, off, len);
            return;
        }
        if (len > length - count) {
            flushBuffer();
        }
        System.arraycopy(b, off, buf, count, len);
        count += len;
    }

    @Override
    public synchronized void flush() throws IOException {
        if (buf == null) {
            throw new IOException("Stream closed " + os);
        }
        flushBuffer();
        os.flush();
    }

    @Override
    @DischargesObligation
    public synchronized void close() throws IOException {
        if (buf != null) {
            try (OutputStream los = os) {
                flush();
            } finally {
                this.bufferProvider.recycle(buf);
                buf = null;
            }
        }
    }

    @Override
    public String toString() {
        return "BufferedOutputStream{" + "buf=" + (buf != null ? Base64.encodeBase64(buf) : "null")
                + ", length=" + length + ", os=" + os + ", bufferProvider="
                + bufferProvider + ", count=" + count + '}';
    }



}