Package org.sellcom.core.io

Class Io

java.lang.Object

org.sellcom.core.io.Io

public class Io
extends java.lang.Object

I/O operations.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
static void	close(java.io.Closeable closeable)	Closes the given Closeable, ignoring any possible I/O exception.
static int	copyBytes(java.io.InputStream source, java.io.OutputStream destination)	Copies all bytes from the given source to the given destination.
static void	copyBytes(java.io.InputStream source, java.io.OutputStream destination, int byteCount)	Copies the given number of bytes from the given source to the given destination.
static int	discardBytes(java.io.InputStream source)	Discards all bytes from the given source.
static void	discardBytes(java.io.InputStream source, int byteCount)	Discards the given number of bytes from the given source.
static int	getBufferSize()	Returns the size of the buffer (in bytes) used in I/O operations.
static byte	readByte(java.io.InputStream source)	Reads a byte from the given source.
static byte[]	readBytes(java.io.InputStream source)	Reads all bytes from the given source.
static byte[]	readBytes(java.io.InputStream source, int byteCount)	Reads the given number of bytes from the given source.
static char	readChar(java.io.InputStream source)	Reads a char from the given source using the default (big-endian) byte order.
static char	readChar(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a char from the given source using the given byte order.
static double	readDouble(java.io.InputStream source)	Reads a double from the given source using the default (big-endian) byte order.
static double	readDouble(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a double from the given source using the given byte order.
static float	readFloat(java.io.InputStream source)	Reads a float from the given source using the default (big-endian) byte order.
static float	readFloat(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a float from the given source using the given byte order.
static int	readInt(java.io.InputStream source)	Reads an int from the given source using the default (big-endian) byte order.
static int	readInt(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads an int from the given source using the given byte order.
static long	readLong(java.io.InputStream source)	Reads a long from the given source using the default (big-endian) byte order.
static long	readLong(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a long from the given source using the given byte order.
static short	readShort(java.io.InputStream source)	Reads a short from the given source using the default (big-endian) byte order.
static short	readShort(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a short from the given source using the given byte order.
static java.lang.String	readString(java.io.InputStream source)	Reads all bytes from the given source and converts them to a string using UTF-8.
static java.lang.String	readString(java.io.InputStream source, int byteCount)	Reads the given number of bytes from the given source and converts them to a string using UTF-8.
static java.lang.String	readString(java.io.InputStream source, int byteCount, java.nio.charset.Charset charset)	Reads the given number of bytes from the given source and converts them to a string using the given charset.
static java.lang.String	readString(java.io.InputStream source, java.nio.charset.Charset charset)	Reads all bytes from the given source and converts them to a string using the given charset.
static int	readUnsignedByte(java.io.InputStream source)	Reads an unsigned byte from the given source.
static java.util.UUID	readUuid(java.io.InputStream source)	Reads a UUID} from the given source using the default (big-endian) byte order.
static java.util.UUID	readUuid(java.io.InputStream source, java.nio.ByteOrder byteOrder)	Reads a UUID} from the given source using the given byte order.
static void	setBufferSize(int bufferSize)	Sets the size of the buffer (in bytes) used in I/O operations.
static void	writeByte(java.io.OutputStream destination, byte value)	Writes a byte to the given destination.
static void	writeBytes(java.io.OutputStream destination, byte[] bytes)	Writes the given bytes to the given destination.
static void	writeChar(java.io.OutputStream destination, char value)	Writes a char to the given destination using the default (big-endian) byte order.
static void	writeChar(java.io.OutputStream destination, char value, java.nio.ByteOrder byteOrder)	Writes a char to the given destination using the given byte order.
static void	writeDouble(java.io.OutputStream destination, double value)	Writes a double to the given destination using the default (big-endian) byte order.
static void	writeDouble(java.io.OutputStream destination, double value, java.nio.ByteOrder byteOrder)	Writes a double to the given destination using the given byte order.
static void	writeFloat(java.io.OutputStream destination, float value)	Writes a float to the given destination using the default (big-endian) byte order.
static void	writeFloat(java.io.OutputStream destination, float value, java.nio.ByteOrder byteOrder)	Writes a float to the given destination using the given byte order.
static void	writeInt(java.io.OutputStream destination, int value)	Writes an int to the given destination using the default (big-endian) byte order.
static void	writeInt(java.io.OutputStream destination, int value, java.nio.ByteOrder byteOrder)	Writes an int to the given destination using the given byte order.
static void	writeLong(java.io.OutputStream destination, long value)	Writes a long to the given destination using the default (big-endian) byte order.
static void	writeLong(java.io.OutputStream destination, long value, java.nio.ByteOrder byteOrder)	Writes a long to the given destination using the given byte order.
static void	writeShort(java.io.OutputStream destination, short value)	Writes a short to the given destination using the default (big-endian) byte order.
static void	writeShort(java.io.OutputStream destination, short value, java.nio.ByteOrder byteOrder)	Writes a short to the given destination using the given byte order.
static void	writeString(java.io.OutputStream destination, java.lang.String string)	Writes the given string to the given destination using UTF-8.
static void	writeString(java.io.OutputStream destination, java.lang.String string, java.nio.charset.Charset charset)	Writes the given string to the given destination using the given charset.
static void	writeUnsignedByte(java.io.OutputStream destination, int value)	Writes an unsigned byte to the given destination.
static void	writeUuid(java.io.OutputStream destination, java.util.UUID uuid)	Writes a UUID to the given destination using the default (big-endian) byte order.
static void	writeUuid(java.io.OutputStream destination, java.util.UUID uuid, java.nio.ByteOrder byteOrder)	Writes a UUID to the given destination using the given byte order.

Methods inherited from class java.lang.Object

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

Method Detail

close

public static void close(java.io.Closeable closeable)

Closes the given Closeable, ignoring any possible I/O exception.

Since:

1.0

copyBytes

public static int copyBytes(java.io.InputStream source,
                            java.io.OutputStream destination)
                     throws java.io.IOException

Copies all bytes from the given source to the given destination. Returns the number of bytes copied.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

copyBytes

public static void copyBytes(java.io.InputStream source,
                             java.io.OutputStream destination,
                             int byteCount)
                      throws java.io.IOException

Copies the given number of bytes from the given source to the given destination. Copies all bytes if the number of bytes is negative.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

discardBytes

public static int discardBytes(java.io.InputStream source)
                        throws java.io.IOException

Discards all bytes from the given source. Returns the number of bytes discarded.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

discardBytes

public static void discardBytes(java.io.InputStream source,
                                int byteCount)
                         throws java.io.IOException

Discards the given number of bytes from the given source. Discards all bytes if the number of bytes is negative.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

getBufferSize

public static int getBufferSize()

Returns the size of the buffer (in bytes) used in I/O operations.

Since:

1.0

readByte

public static byte readByte(java.io.InputStream source)
                     throws java.io.IOException

Reads a byte from the given source.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readBytes

public static byte[] readBytes(java.io.InputStream source)
                        throws java.io.IOException

Reads all bytes from the given source.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readBytes

public static byte[] readBytes(java.io.InputStream source,
                               int byteCount)
                        throws java.io.IOException

Reads the given number of bytes from the given source. Reads all bytes if the number of bytes is negative.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readChar

public static char readChar(java.io.InputStream source)
                     throws java.io.IOException

Reads a char from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readChar

public static char readChar(java.io.InputStream source,
                            java.nio.ByteOrder byteOrder)
                     throws java.io.IOException

Reads a char from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readDouble

public static double readDouble(java.io.InputStream source)
                         throws java.io.IOException

Reads a double from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readDouble

public static double readDouble(java.io.InputStream source,
                                java.nio.ByteOrder byteOrder)
                         throws java.io.IOException

Reads a double from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readFloat

public static float readFloat(java.io.InputStream source)
                       throws java.io.IOException

Reads a float from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readFloat

public static float readFloat(java.io.InputStream source,
                              java.nio.ByteOrder byteOrder)
                       throws java.io.IOException

Reads a float from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readInt

public static int readInt(java.io.InputStream source)
                   throws java.io.IOException

Reads an int from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readInt

public static int readInt(java.io.InputStream source,
                          java.nio.ByteOrder byteOrder)
                   throws java.io.IOException

Reads an int from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readLong

public static long readLong(java.io.InputStream source)
                     throws java.io.IOException

Reads a long from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readLong

public static long readLong(java.io.InputStream source,
                            java.nio.ByteOrder byteOrder)
                     throws java.io.IOException

Reads a long from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readShort

public static short readShort(java.io.InputStream source)
                       throws java.io.IOException

Reads a short from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readShort

public static short readShort(java.io.InputStream source,
                              java.nio.ByteOrder byteOrder)
                       throws java.io.IOException

Reads a short from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readString

public static java.lang.String readString(java.io.InputStream source)
                                   throws java.io.IOException

Reads all bytes from the given source and converts them to a string using UTF-8.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readString

public static java.lang.String readString(java.io.InputStream source,
                                          java.nio.charset.Charset charset)
                                   throws java.io.IOException

Reads all bytes from the given source and converts them to a string using the given charset.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if charset is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readString

public static java.lang.String readString(java.io.InputStream source,
                                          int byteCount)
                                   throws java.io.IOException

Reads the given number of bytes from the given source and converts them to a string using UTF-8. Reads all bytes if the number of bytes is negative.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readString

public static java.lang.String readString(java.io.InputStream source,
                                          int byteCount,
                                          java.nio.charset.Charset charset)
                                   throws java.io.IOException

Reads the given number of bytes from the given source and converts them to a string using the given charset. Reads all bytes if the number of bytes is negative.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if charset is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readUnsignedByte

public static int readUnsignedByte(java.io.InputStream source)
                            throws java.io.IOException

Reads an unsigned byte from the given source.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readUuid

public static java.util.UUID readUuid(java.io.InputStream source)
                               throws java.io.IOException

Reads a UUID} from the given source using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.io.IOException - if an I/O error occurs

Since:

1.0

readUuid

public static java.util.UUID readUuid(java.io.InputStream source,
                                      java.nio.ByteOrder byteOrder)
                               throws java.io.IOException

Reads a UUID} from the given source using the given byte order.

Throws:

java.lang.IllegalArgumentException - if source is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

setBufferSize

public static void setBufferSize(int bufferSize)

Sets the size of the buffer (in bytes) used in I/O operations.

Throws:

java.lang.IllegalArgumentException - if bufferSize is not positive

Since:

1.0

writeByte

public static void writeByte(java.io.OutputStream destination,
                             byte value)
                      throws java.io.IOException

Writes a byte to the given destination.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeBytes

public static void writeBytes(java.io.OutputStream destination,
                              byte[] bytes)
                       throws java.io.IOException

Writes the given bytes to the given destination.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if bytes are null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeChar

public static void writeChar(java.io.OutputStream destination,
                             char value)
                      throws java.io.IOException

Writes a char to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeChar

public static void writeChar(java.io.OutputStream destination,
                             char value,
                             java.nio.ByteOrder byteOrder)
                      throws java.io.IOException

Writes a char to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeDouble

public static void writeDouble(java.io.OutputStream destination,
                               double value)
                        throws java.io.IOException

Writes a double to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeDouble

public static void writeDouble(java.io.OutputStream destination,
                               double value,
                               java.nio.ByteOrder byteOrder)
                        throws java.io.IOException

Writes a double to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeFloat

public static void writeFloat(java.io.OutputStream destination,
                              float value)
                       throws java.io.IOException

Writes a float to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeFloat

public static void writeFloat(java.io.OutputStream destination,
                              float value,
                              java.nio.ByteOrder byteOrder)
                       throws java.io.IOException

Writes a float to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeInt

public static void writeInt(java.io.OutputStream destination,
                            int value)
                     throws java.io.IOException

Writes an int to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeInt

public static void writeInt(java.io.OutputStream destination,
                            int value,
                            java.nio.ByteOrder byteOrder)
                     throws java.io.IOException

Writes an int to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeLong

public static void writeLong(java.io.OutputStream destination,
                             long value)
                      throws java.io.IOException

Writes a long to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeLong

public static void writeLong(java.io.OutputStream destination,
                             long value,
                             java.nio.ByteOrder byteOrder)
                      throws java.io.IOException

Writes a long to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeShort

public static void writeShort(java.io.OutputStream destination,
                              short value)
                       throws java.io.IOException

Writes a short to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeShort

public static void writeShort(java.io.OutputStream destination,
                              short value,
                              java.nio.ByteOrder byteOrder)
                       throws java.io.IOException

Writes a short to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if byteOrder is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeString

public static void writeString(java.io.OutputStream destination,
                               java.lang.String string)
                        throws java.io.IOException

Writes the given string to the given destination using UTF-8.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if string is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeString

public static void writeString(java.io.OutputStream destination,
                               java.lang.String string,
                               java.nio.charset.Charset charset)
                        throws java.io.IOException

Writes the given string to the given destination using the given charset.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if string is null

java.lang.IllegalArgumentException - if charset is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeUnsignedByte

public static void writeUnsignedByte(java.io.OutputStream destination,
                                     int value)
                              throws java.io.IOException

Writes an unsigned byte to the given destination.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeUuid

public static void writeUuid(java.io.OutputStream destination,
                             java.util.UUID uuid)
                      throws java.io.IOException

Writes a UUID to the given destination using the default (big-endian) byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if uuid is null

java.io.IOException - if an I/O error occurs

Since:

1.0

writeUuid

public static void writeUuid(java.io.OutputStream destination,
                             java.util.UUID uuid,
                             java.nio.ByteOrder byteOrder)
                      throws java.io.IOException

Writes a UUID to the given destination using the given byte order.

Throws:

java.lang.IllegalArgumentException - if destination is null

java.lang.IllegalArgumentException - if uuid is null

java.io.IOException - if an I/O error occurs

Since:

1.0