it.unimi.dsi.fastutil.io.FastBufferedOutputStream Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2005-2023 Sebastiano Vigna
*
* 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 it.unimi.dsi.fastutil.io;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.channels.FileChannel;
/** Lightweight, unsynchronized output stream buffering class with
* {@linkplain MeasurableStream measurability} and
* {@linkplain RepositionableStream repositionability}.
*
* This class provides buffering for output streams, but it does so with
* purposes and an internal logic that are radically different from the ones
* adopted in {@link java.io.BufferedOutputStream}. The main features follow.
*
*
* All methods are unsychronized.
*
*
As an additional feature, this class implements the {@link
* RepositionableStream} and {@link MeasurableStream} interfaces.
* An instance of this class will try to cast
* the underlying byte stream to a {@link RepositionableStream} and to fetch by
* reflection the {@link java.nio.channels.FileChannel} underlying the given
* output stream, in this order. If either reference can be successfully
* fetched, you can use {@link #position(long)} to reposition the stream.
* Much in the same way, an instance of this class will try to cast the
* the underlying byte stream to a {@link MeasurableStream}, and if this
* operation is successful, or if a {@link java.nio.channels.FileChannel} can
* be detected, then {@link #position()} and {@link #length()} will work as expected.
*
* @since 4.4
*/
public class FastBufferedOutputStream extends MeasurableOutputStream implements RepositionableStream {
private static final boolean ASSERTS = false;
/** The default size of the internal buffer in bytes (8Ki). */
public static final int DEFAULT_BUFFER_SIZE = 8 * 1024;
/** The internal buffer. */
protected byte buffer[];
/** The current position in the buffer. */
protected int pos;
/** The number of buffer bytes available starting from {@link #pos}
* (it must be always equal to {@code buffer.length - pos}). */
protected int avail;
/** The underlying output stream. */
protected OutputStream os;
/** The cached file channel underlying {@link #os}, if any. */
private FileChannel fileChannel;
/** {@link #os} cast to a positionable stream, if possible. */
private RepositionableStream repositionableStream;
/** {@link #os} cast to a measurable stream, if possible. */
private MeasurableStream measurableStream;
private static int ensureBufferSize(final int bufferSize) {
if (bufferSize <= 0) throw new IllegalArgumentException("Illegal buffer size: " + bufferSize);
return bufferSize;
}
/** Creates a new fast buffered output stream by wrapping a given output stream with a given buffer.
*
* @param os an output stream to wrap.
* @param buffer a buffer of positive length.
*/
public FastBufferedOutputStream(final OutputStream os, final byte[] buffer) {
this.os = os;
ensureBufferSize(buffer.length);
this.buffer = buffer;
avail = buffer.length;
if (os instanceof RepositionableStream) repositionableStream = (RepositionableStream)os;
if (os instanceof MeasurableStream) measurableStream = (MeasurableStream)os;
if (repositionableStream == null) {
try {
fileChannel = (FileChannel)(os.getClass().getMethod("getChannel", new Class[] {})).invoke(os);
}
catch(final IllegalAccessException e) {}
catch(final IllegalArgumentException e) {}
catch(final NoSuchMethodException e) {}
catch(final java.lang.reflect.InvocationTargetException e) {}
catch(final ClassCastException e) {}
}
}
/** Creates a new fast buffered output stream by wrapping a given output stream with a given buffer size.
*
* @param os an output stream to wrap.
* @param bufferSize the size in bytes of the internal buffer.
*/
public FastBufferedOutputStream(final OutputStream os, final int bufferSize) {
this(os, new byte[ensureBufferSize(bufferSize)]);
}
/** Creates a new fast buffered ouptut stream by wrapping a given output stream with a buffer of {@link #DEFAULT_BUFFER_SIZE} bytes.
*
* @param os an output stream to wrap.
*/
public FastBufferedOutputStream(final OutputStream os) {
this(os, DEFAULT_BUFFER_SIZE);
}
private void dumpBuffer(final boolean ifFull) throws IOException {
if (pos == 0) return; // nothing to dump
if (! ifFull || avail == 0) {
os.write(buffer, 0, pos);
pos = 0;
avail = buffer.length;
}
}
@Override
public void write(final int b) throws IOException {
if (ASSERTS) assert avail > 0;
avail--;
buffer[pos++] = (byte)b;
dumpBuffer(true);
}
@Override
public void write(final byte b[], final int offset, final int length) throws IOException {
if (length >= buffer.length) {
dumpBuffer(false);
os.write(b, offset, length);
return;
}
if (length <= avail) {
// Copy in buffer
System.arraycopy(b, offset, buffer, pos, length);
pos += length;
avail -= length;
dumpBuffer(true);
return;
}
dumpBuffer(false);
System.arraycopy(b, offset, buffer, 0, length);
pos = length;
avail -= length;
}
@Override
public void flush() throws IOException {
dumpBuffer(false);
os.flush();
}
@Override
public void close() throws IOException {
if (os == null) return;
flush();
if (os != System.out) os.close();
os = null;
buffer = null;
}
@Override
public long position() throws IOException {
if (repositionableStream != null) return repositionableStream.position() + pos;
else if (measurableStream != null) return measurableStream.position() + pos;
else if (fileChannel != null) return fileChannel.position() + pos;
else throw new UnsupportedOperationException("position() can only be called if the underlying byte stream implements the MeasurableStream or RepositionableStream interface or if the getChannel() method of the underlying byte stream exists and returns a FileChannel");
}
/** Repositions the stream.
*
* Note that this method performs a {@link #flush()} before changing the underlying stream position.
*/
@Override
public void position(final long newPosition) throws IOException {
flush();
if (repositionableStream != null) repositionableStream.position(newPosition);
else if (fileChannel != null) fileChannel.position(newPosition);
else throw new UnsupportedOperationException("position() can only be called if the underlying byte stream implements the RepositionableStream interface or if the getChannel() method of the underlying byte stream exists and returns a FileChannel");
}
/** Returns the length of the underlying output stream, if it is {@linkplain MeasurableStream measurable}.
*
*
Note that this method performs a {@link #flush()} before detecting the length.
*
* @return the length of the underlying output stream.
* @throws UnsupportedOperationException if the underlying output stream is not {@linkplain MeasurableStream measurable} and
* cannot provide a {@link FileChannel}.
*/
@Override
public long length() throws IOException {
flush();
if (measurableStream != null) return measurableStream.length();
if (fileChannel != null) return fileChannel.size();
throw new UnsupportedOperationException();
}
}