org.apache.commons.io.input.buffer.CircularBufferInputStream Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-io Show documentation
Show all versions of commons-io Show documentation
The Apache Commons IO library contains utility classes, stream implementations, file filters,
file comparators, endian transformation classes, and much more.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.commons.io.input.buffer;
import java.io.IOException;
import java.io.InputStream;
import java.util.Objects;
import org.apache.commons.io.IOUtils;
/**
* Implementation of a buffered input stream, which is internally based on the
* {@link CircularByteBuffer}. Unlike the {@link java.io.BufferedInputStream}, this one
* doesn't need to reallocate byte arrays internally.
*/
public class CircularBufferInputStream extends InputStream {
protected final InputStream in;
protected final CircularByteBuffer buffer;
protected final int bufferSize;
private boolean eofSeen;
/**
* Creates a new instance, which filters the given input stream, and
* uses the given buffer size.
*
* @param inputStream The input stream, which is being buffered.
* @param bufferSize The size of the {@link CircularByteBuffer}, which is
* used internally.
*/
public CircularBufferInputStream(final InputStream inputStream, final int bufferSize) {
if (bufferSize <= 0) {
throw new IllegalArgumentException("Invalid bufferSize: " + bufferSize);
}
this.in = Objects.requireNonNull(inputStream, "inputStream");
this.buffer = new CircularByteBuffer(bufferSize);
this.bufferSize = bufferSize;
this.eofSeen = false;
}
/**
* Creates a new instance, which filters the given input stream, and
* uses a reasonable default buffer size ({@link IOUtils#DEFAULT_BUFFER_SIZE}).
*
* @param inputStream The input stream, which is being buffered.
*/
public CircularBufferInputStream(final InputStream inputStream) {
this(inputStream, IOUtils.DEFAULT_BUFFER_SIZE);
}
/**
* Fills the buffer with the contents of the input stream.
*
* @throws IOException in case of an error while reading from the input stream.
*/
protected void fillBuffer() throws IOException {
if (eofSeen) {
return;
}
int space = buffer.getSpace();
final byte[] buf = new byte[space];
while (space > 0) {
final int res = in.read(buf, 0, space);
if (res == -1) {
eofSeen = true;
return;
} else if (res > 0) {
buffer.add(buf, 0, res);
space -= res;
}
}
}
/**
* Fills the buffer from the input stream until the given number of bytes have been added to the buffer.
*
* @param count number of byte to fill into the buffer
* @return true if the buffer has bytes
* @throws IOException in case of an error while reading from the input stream.
*/
protected boolean haveBytes(final int count) throws IOException {
if (buffer.getCurrentNumberOfBytes() < count) {
fillBuffer();
}
return buffer.hasBytes();
}
@Override
public int read() throws IOException {
if (!haveBytes(1)) {
return -1;
}
return buffer.read();
}
@Override
public int read(final byte[] buffer) throws IOException {
return read(buffer, 0, buffer.length);
}
@Override
public int read(final byte[] targetBuffer, final int offset, final int length) throws IOException {
Objects.requireNonNull(targetBuffer, "Buffer");
if (offset < 0) {
throw new IllegalArgumentException("Offset must not be negative");
}
if (length < 0) {
throw new IllegalArgumentException("Length must not be negative");
}
if (!haveBytes(length)) {
return -1;
}
final int result = Math.min(length, buffer.getCurrentNumberOfBytes());
for (int i = 0; i < result; i++) {
targetBuffer[offset + i] = buffer.read();
}
return result;
}
@Override
public void close() throws IOException {
in.close();
eofSeen = true;
buffer.clear();
}
}