com.upokecenter.util

Class DataIO

java.lang.Object

com.upokecenter.util.DataIO

public final class DataIO
extends Object

Convenience class that contains static methods for wrapping byte arrays and streams into byte readers and byte writers.

Method Summary

Modifier and Type	Method and Description
static IByteReader	ToByteReader(byte[] bytes) Deprecated. Use ToReader instead.
static IByteReader	ToByteReader(byte[] bytes, int offset, int length) Deprecated. Use ToReader instead.
static IByteReader	ToByteReader(InputStream input) Deprecated. Use ToReader instead.
static IReader	ToReader(byte[] bytes) Wraps a byte array into a byte reader.
static IReader	ToReader(byte[] bytes, int offset, int length) Wraps a portion of a byte array into a byte reader object.
static IReader	ToReader(InputStream input) Wraps an input stream into a reader object.
static IWriter	ToWriter(IByteWriter output) Wraps a byte writer (one that only implements a ReadByte method) to a writer (one that also implements a three-parameter Read method.)
static IWriter	ToWriter(OutputStream output) Wraps an output stream into a writer object.

Methods inherited from class java.lang.Object

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

Method Detail

ToReader

public static IReader ToReader(byte[] bytes)

Wraps a byte array into a byte reader. The reader will start at the beginning of the byte array.

In the .NET implementation, this method is implemented as an extension method to any byte array object and can be called as follows: bytes.ToByteReader(). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

bytes - The byte array to wrap.

Returns:

A byte reader wrapping the byte array.

Throws:

NullPointerException - The parameter bytes is null.

ToReader

public static IReader ToReader(byte[] bytes,
                               int offset,
                               int length)

Wraps a portion of a byte array into a byte reader object.

In the .NET implementation, this method is implemented as an extension method to any byte array object and can be called as follows: bytes.ToByteReader(offset, length). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

bytes - The byte array to wrap.

offset - A zero-based index showing where the desired portion of "bytes" begins.

length - The length, in bytes, of the desired portion of "bytes" (but not more than "bytes" 's length).

Returns:

A byte reader wrapping the byte array.

Throws:

NullPointerException - The parameter bytes is null.

IllegalArgumentException - Either offset or length is less than 0 or greater than bytes 's length, or bytes ' s length minus offset is less than length.

ToReader

public static IReader ToReader(InputStream input)

Wraps an input stream into a reader object. If an IOException is thrown by the input stream, the reader object throws InvalidOperationException instead.

In the .NET implementation, this method is implemented as an extension method to any object implementing InputStream and can be called as follows: input.ToByteReader(). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

input - The input stream to wrap.

Returns:

A byte reader wrapping the input stream.

Throws:

NullPointerException - The parameter input is null.

ToByteReader

@Deprecated
public static IByteReader ToByteReader(byte[] bytes,
                                                   int offset,
                                                   int length)

Deprecated. Use ToReader instead.

Not documented yet.

In the .NET implementation, this method is implemented as an extension method to any object implementing byte[] and can be called as follows: bytes.ToByteReader(offset, length). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

bytes - The parameter bytes is not documented yet.

offset - A zero-based index showing where the desired portion of bytes begins.

length - The length, in bytes, of the desired portion of bytes (but not more than bytes 's length).

Returns:

An IByteReader object.

Throws:

IllegalArgumentException - Either offset or length is less than 0 or greater than bytes 's length, or bytes ' s length minus offset is less than length.

NullPointerException - The parameter bytes is null.

ToByteReader

@Deprecated
public static IByteReader ToByteReader(InputStream input)

Deprecated. Use ToReader instead.

Not documented yet.

In the .NET implementation, this method is implemented as an extension method to any object implementing InputStream and can be called as follows: input.ToByteReader(). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

input - The parameter input is not documented yet.

Returns:

An IByteReader object.

ToByteReader

@Deprecated
public static IByteReader ToByteReader(byte[] bytes)

Deprecated. Use ToReader instead.

Not documented yet.

In the .NET implementation, this method is implemented as an extension method to any object implementing byte[] and can be called as follows: bytes.ToByteReader(). If the object's class already has a ToByteReader method with the same parameters, that method takes precedence over this extension method.

Parameters:

bytes - The parameter bytes is not documented yet.

Returns:

An IByteReader object.

ToWriter

public static IWriter ToWriter(OutputStream output)

Wraps an output stream into a writer object. If an IOException is thrown by the input stream, the writer object throws InvalidOperationException instead.

In the .NET implementation, this method is implemented as an extension method to any object implementing InputStream and can be called as follows: output.ToWriter(). If the object's class already has a ToWriter method with the same parameters, that method takes precedence over this extension method.

Parameters:

output - Output stream to wrap.

Returns:

A byte writer that wraps the given output stream.

Throws:

NullPointerException - The parameter output is null.

ToWriter

public static IWriter ToWriter(IByteWriter output)

Wraps a byte writer (one that only implements a ReadByte method) to a writer (one that also implements a three-parameter Read method.)

In the .NET implementation, this method is implemented as an extension method to any object implementing IByteWriter and can be called as follows: output.ToWriter(). If the object's class already has a ToWriter method with the same parameters, that method takes precedence over this extension method.

Parameters:

output - A byte stream.

Returns:

A writer that wraps the given stream.

Throws:

NullPointerException - The parameter output is null.