com.gc.iotools.stream.utils

Class StreamUtils

java.lang.Object

com.gc.iotools.stream.utils.StreamUtils

public final class StreamUtils
extends Object

General utilities for handling streams.

Since:

1.0.9

Version:

$Id: StreamUtils.java 463 2013-01-21 23:54:17Z G.Contini@gmail.com $

Author:

G.Contini

Method Summary

Modifier and Type	Method and Description
static String	getRateString(long bytes, long milliseconds) Returns a string representing the transfer rate.
static String	getRateString(long bytes, long milliseconds, Locale locale) Returns a string representing the transfer rate.
static byte[]	read(InputStream source, int size) Read a specified amount of bytes from the source InputStream and place them into the returned byte array.
static int	tryReadFully(InputStream source, byte[] buffer, int offset, int len) Read bytes from the source InputStream into the buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRateString

public static String getRateString(long bytes,
                                   long milliseconds)

Returns a string representing the transfer rate. The unit is chosen automatically to keep the size of the string small.

Parameters:

bytes - bytes transferred

milliseconds - time in milliseconds

Returns:

a string containing the bit rate in a convenient unit.

Since:

1.2.2

getRateString

public static String getRateString(long bytes,
                                   long milliseconds,
                                   Locale locale)

Returns a string representing the transfer rate. The unit is chosen automatically to keep the size of the string small.

Parameters:

bytes - bytes transferred

milliseconds - time in milliseconds

locale - the current locale to get the right decimal separators. If null default locale will be used.

Returns:

a string containing the bit rate in a convenient unit.

Since:

1.2.13

read

public static byte[] read(InputStream source,
                          int size)
                   throws IOException

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. If the end of stream has been reached the returned array length is the length of the data read.

Parameters:

source - Stream from which the data is read.

size - The maximum length of the data read.

Returns:

byte[] containing the data read from the stream. null if the stream was 0 length, or a byte[] whose length is the length of the stream if the EOS 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.

IOException - if any.

Since:

1.0.9

tryReadFully

public static int tryReadFully(InputStream source,
                               byte[] buffer,
                               int offset,
                               int len)
                        throws IOException

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.

Parameters:

source - Stream from which the data is read.

buffer - the buffer into which the data is read.

offset - the start offset in array buffer at which the data is written.

len - maximum length of the bytes read.

Returns:

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.

NullPointerException - If b is null.

IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

Since:

1.0.8

See Also:

InputStream.read(byte[] buf,int off, int len)