org.walluck.io

Class DataInputStreamEx

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.DataInputStream

org.walluck.io.DataInputStreamEx

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable

Direct Known Subclasses:

LittleEndianInputStream

public class DataInputStreamEx
extends DataInputStream

A DataInputStream with a few more methods.

Since:

1.0

Version:

1.0

Author:

David Walluck

See Also:

DataInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
DataInputStreamEx(InputStream is) Creates a new data input stream ex.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	readBytes(int length) Read exactly the specified number of bytes from the stream.
String	readString(int length) Read a string of the specified length from the stream.
String	readString0(short length) Read a null-terminated string of the specified length from the stream.
String	readStringL() Read a byte length prefixed string from the stream.
String	readStringLL() Read a short length prefixed string from the stream.
String	readStringNullPadded(int length, String charset) Read a null-padded string of length from an input stream.
String	readStringUntilNull(int length) Read a string from an input stream until a null is reached.

Methods inherited from class java.io.DataInputStream

read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, readUTF, skipBytes

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

DataInputStreamEx

public DataInputStreamEx(InputStream is)

Creates a new data input stream ex.

Parameters:

is - the underlying input stream

Method Detail

readString

public String readString(int length)
                  throws IOException

Read a string of the specified length from the stream.

Parameters:

length - the length

Returns:

the string

Throws:

IOException - if an error occurs

readString0

public String readString0(short length)
                   throws IOException

Read a null-terminated string of the specified length from the stream.

Parameters:

length - the length

Returns:

the string

Throws:

IOException - if an error occurs

readStringL

public String readStringL()
                   throws IOException

Read a byte length prefixed string from the stream.

Returns:

the string

Throws:

IOException - if an error occurs

readStringLL

public String readStringLL()
                    throws IOException

Read a short length prefixed string from the stream.

Returns:

the string

Throws:

IOException - if an error occurs

readBytes

public byte[] readBytes(int length)
                 throws IOException

Read exactly the specified number of bytes from the stream.

Parameters:

length - the length

Returns:

the byte array

Throws:

IOException - if an error occurs

readStringUntilNull

public String readStringUntilNull(int length)
                           throws IOException

Read a string from an input stream until a null is reached.

Parameters:

length - the maximum length that the string can be

Returns:

the string

Throws:

IOException - if an error occurs

readStringNullPadded

public String readStringNullPadded(int length,
                          String charset)
                            throws IOException

Read a null-padded string of length from an input stream.

Parameters:

length - the maximum length that the tring can be

charset - the Java charset

Returns:

the string

Throws:

IOException - if an error occurs