com.github.ykiselev.binary.format

Interface ReadableMedia

All Known Implementing Classes:

SimpleReadableMedia

public interface ReadableMedia

Created by Y.Kiselev on 26.06.2016.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	readBoolean()
byte	readByte()
byte[]	readByteArray()
char	readChar()
char[]	readCharArray()
double	readDouble()
double[]	readDoubleArray()
float	readFloat()
float[]	readFloatArray()
int	readInt()
int[]	readIntArray()
long	readLong()
long[]	readLongArray()
<T> T	readObject(Class<T> type)
<T> T[]	readObjectArray(Class<T> itemType)
int	readPackedInteger() Reads packed positive integer (1-5 bytes)
void	readRest(BinaryOutput output, ArrayFactory arrayFactory) Reads the rest of user object data till the end marker.
short	readShort()
short[]	readShortArray()
String	readString()

Method Detail

readPackedInteger

int readPackedInteger()
                      throws IOException

Reads packed positive integer (1-5 bytes)

Returns:

the length (positive integer)

Throws:

IOException

readString

String readString()
                  throws IOException

Throws:

IOException

readByte

byte readByte()
              throws IOException

Throws:

IOException

readChar

char readChar()
              throws IOException

Throws:

IOException

readShort

short readShort()
                throws IOException

Throws:

IOException

readInt

int readInt()
            throws IOException

Throws:

IOException

readLong

long readLong()
              throws IOException

Throws:

IOException

readFloat

float readFloat()
                throws IOException

Throws:

IOException

readDouble

double readDouble()
                  throws IOException

Throws:

IOException

readBoolean

boolean readBoolean()
                    throws IOException

Throws:

IOException

readObject

<T> T readObject(Class<T> type)
             throws IOException

Throws:

IOException

readByteArray

byte[] readByteArray()
                     throws IOException

Throws:

IOException

readCharArray

char[] readCharArray()
                     throws IOException

Throws:

IOException

readShortArray

short[] readShortArray()
                       throws IOException

Throws:

IOException

readIntArray

int[] readIntArray()
                   throws IOException

Throws:

IOException

readLongArray

long[] readLongArray()
                     throws IOException

Throws:

IOException

readFloatArray

float[] readFloatArray()
                       throws IOException

Throws:

IOException

readDoubleArray

double[] readDoubleArray()
                         throws IOException

Throws:

IOException

readObjectArray

<T> T[] readObjectArray(Class<T> itemType)
                    throws IOException

Throws:

IOException

readRest

void readRest(BinaryOutput output,
            ArrayFactory arrayFactory)
              throws IOException

Reads the rest of user object data till the end marker. Note: returned byte array not includes corresponding object's end marker. This method may only be called from UserTypeInput.read(ReadableMedia, Class) i.e. after user type marker is extracted from input. This method is designed to support multi-versioned object binaries.

Parameters:

output - the output to write rest of object bytes to.

arrayFactory - the array factory for temporal buffers creation.

Throws:

IOException - if reading error occurred (like end of stream, etc).