org.eclipse.jetty.io.ByteBufferOutputStream2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.11.18751.20241128T090041Z-241100
// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.io;

import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;

/**
 *  This class implements an output stream in which the data is written into a list of ByteBuffer,
 *  the buffer list automatically grows as data is written to it, the buffers are taken from the
 *  supplied {@link ByteBufferPool} or freshly allocated if one is not supplied.
 *
 *  Designed to mimic {@link java.io.ByteArrayOutputStream} but with better memory usage, and less copying.
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
public class ByteBufferOutputStream2 extends OutputStream {

    private final ByteBufferAccumulator _accumulator;

    private int _size = 0;

    public ByteBufferOutputStream2() {
        this(null, false);
    }

    public ByteBufferOutputStream2(ByteBufferPool bufferPool, boolean direct) {
        _accumulator = new ByteBufferAccumulator((bufferPool == null) ? new NullByteBufferPool() : bufferPool, direct);
    }

    public ByteBufferPool getByteBufferPool() {
        return _accumulator.getByteBufferPool();
    }

    /**
     * Take the combined buffer containing all content written to the OutputStream.
     * The caller is responsible for releasing this {@link ByteBuffer} back into the {@link ByteBufferPool}.
     * @return a buffer containing all content written to the OutputStream.
     */
    public ByteBuffer takeByteBuffer() {
        return _accumulator.takeByteBuffer();
    }

    /**
     * Take the combined buffer containing all content written to the OutputStream.
     * The returned buffer is still contained within the OutputStream and will be released back to the {@link ByteBufferPool}
     * when the OutputStream is closed.
     * @return a buffer containing all content written to the OutputStream.
     */
    public ByteBuffer toByteBuffer() {
        return _accumulator.toByteBuffer();
    }

    /**
     * @return a newly allocated byte array containing all content written into the OutputStream.
     */
    public byte[] toByteArray() {
        return _accumulator.toByteArray();
    }

    public int size() {
        return _size;
    }

    @Override
    public void write(int b) {
        write(new byte[] { (byte) b }, 0, 1);
    }

    @Override
    public void write(byte[] b, int off, int len) {
        _size += len;
        _accumulator.copyBytes(b, off, len);
    }

    public void write(ByteBuffer buffer) {
        _size += buffer.remaining();
        _accumulator.copyBuffer(buffer);
    }

    public void writeTo(ByteBuffer buffer) {
        _accumulator.writeTo(buffer);
    }

    public void writeTo(OutputStream out) throws IOException {
        _accumulator.writeTo(out);
    }

    @Override
    public void close() {
        _accumulator.close();
        _size = 0;
    }

    @Override
    public synchronized String toString() {
        return String.format("%s@%x{size=%d, byteAccumulator=%s}", getClass().getSimpleName(), hashCode(), _size, _accumulator);
    }
}