com.gc.iotools.stream.utils.StreamUtils Maven / Gradle / Ivy
package com.gc.iotools.stream.utils;
/*
* Copyright (c) 2008, Davide Simonetti
* All rights reserved.
* Redistribution and use in source and binary forms,
* with or without modification, are permitted provided that the following
* conditions are met:
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither the name of Davide Simonetti nor the names of its contributors may
* be used to endorse or promote products derived from this software without
* specific prior written permission.
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
import java.io.IOException;
import java.io.InputStream;
import java.text.DecimalFormat;
/**
* General utilities for handling streams.
*
* @author dvd.smnt
* @since 1.0.9
*/
public final class StreamUtils {
private static final int KB = 1024;
/**
* Returns a string representing the transfer rate. The unit is chosen
* automatically to keep the size of the string small.
*
* @param bytes
* bytes transferred
* @param milliseconds
* time in milliseconds
* @return a string containing the bit rate in a convenient unit.
* @since 1.2.2
*/
public static String getRateString(final long bytes,
final long milliseconds) {
final String[] units = new String[] { "Byte", "KB", "MB", "GB" };
final double bytesSec = (bytes * 1000D) / milliseconds;
// log1024(bytesSec)
final double idx = Math.log(bytesSec) / Math.log(KB);
final int intIdx = Math.max(0, Math.min((int) Math.floor(idx),
units.length - 1));
final double reducedRate = bytesSec / Math.pow(KB, intIdx);
final DecimalFormat df = new DecimalFormat();
final int ndigit = (int) Math.floor(Math.max(Math.log10(reducedRate),
0));
df.setMinimumFractionDigits(0);
df.setGroupingUsed(false);
df.setMaximumFractionDigits(Math.max(0, 2 - ndigit));
return df.format(reducedRate) + " " + units[intIdx] + "/sec";
}
/**
*
* Read a specified amount of bytes from the source InputStream and
* place them into the returned byte array.
*
*
* This utility ensures that either size bytes are read or the
* end of the stream has been reached.
*
* @param source
* Stream from which the data is read.
* @param size
* The maximum length of the data read.
* @return byte[] containing the data read from the stream.
* null if the End Of File has been reached.
* @exception IOException
* If the first byte cannot be read for any reason other than
* end of file, or if the input stream has been closed, or if
* some other I/O error occurs.
* @since 1.0.9
*/
public static byte[] read(final InputStream source, final int size)
throws IOException {
final byte[] test = new byte[size];
final int n = tryReadFully(source, test, 0, size);
byte[] result = test;
if (n < size) {
if (n <= 0) {
result = null;
} else {
result = new byte[n];
System.arraycopy(test, 0, result, 0, n);
}
}
return result;
}
/**
*
* Read bytes from the source InputStream into the
* buffer.
*
*
* This utility ensures that either len bytes are read or the
* end of the stream has been reached.
*
*
* @see InputStream#read(byte[] buf,int off, int len)
*
* @param source
* Stream from which the data is read.
* @param buffer
* the buffer into which the data is read.
* @param offset
* the start offset in array buffer at which the
* data is written.
* @param len
* maximum length of the bytes read.
*
* @return the total number of bytes read into the buffer, or
* -1 if there is no more data because the end of the
* stream has been reached.
*
* @throws IOException
* If the first byte cannot be read for any reason other than
* end of file, or if the input stream has been closed, or if
* some other I/O error occurs.
* @exception NullPointerException
* If b is null.
* @exception IndexOutOfBoundsException
* If off is negative, len is
* negative, or len is greater than
* b.length - off
*
* @since 1.0.8
*/
public static int tryReadFully(final InputStream source,
final byte[] buffer, final int offset, final int len)
throws IOException {
if (len < 0) {
throw new IndexOutOfBoundsException("len [" + len + "] < 0");
}
int n = 0;
while (n < len) {
final int count = source.read(buffer, offset + n, len - n);
if (count < 0) {
if (n == 0) {
n = count;
}
break;
}
n += count;
}
return n;
}
/**
* Utility class: shouldn't be instantiated.
*/
private StreamUtils() {
}
}