org.openimaj.io.wrappers

Class ReadWritableIndependentPair<A,B>

java.lang.Object

org.openimaj.util.pair.IndependentPair<A,B>

org.openimaj.io.wrappers.ReadWritableIndependentPair<A,B>

Type Parameters:

A - Type of first object

B - Type of second object

All Implemented Interfaces:

ReadableBinary, ReadWriteableBinary, WriteableBinary

public abstract class ReadWritableIndependentPair<A,B>
extends IndependentPair<A,B>
implements ReadWriteableBinary

Base class for writing any independent pair.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
ReadWritableIndependentPair(A obj1, B obj2) initialise with data
ReadWritableIndependentPair(IndependentPair<A,B> pair) initialise with an existing pair

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
void	readBinary(DataInput in) Read internal state from in.
abstract A	readFirst(DataInput in)
abstract B	readSecond(DataInput in)
void	writeBinary(DataOutput out) Write the content of this as binary to out.
abstract void	writeFirst(DataOutput out, A firstObject) first object written to out
abstract void	writeSecond(DataOutput out, B secondObject) second object written to out

Methods inherited from class org.openimaj.util.pair.IndependentPair

equals, firstObject, getFirst, getFirstFunction, getFirstObject, getSecond, getSecondFunction, getSecondObject, pair, pairList, secondObject, setFirstObject, setSecondObject, swap, swapList, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWritableIndependentPair

public ReadWritableIndependentPair(A obj1,
                                   B obj2)

initialise with data

Parameters:

obj1 -

obj2 -

ReadWritableIndependentPair

public ReadWritableIndependentPair(IndependentPair<A,B> pair)

initialise with an existing pair

Parameters:

pair -

Method Detail

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

readFirst

public abstract A readFirst(DataInput in)
                     throws IOException

Parameters:

in -

Returns:

first object read from in

Throws:

IOException

readSecond

public abstract B readSecond(DataInput in)
                      throws IOException

Parameters:

in -

Returns:

second object read from in

Throws:

IOException

writeFirst

public abstract void writeFirst(DataOutput out,
                                A firstObject)
                         throws IOException

first object written to out

Parameters:

out -

firstObject -

Throws:

IOException

writeSecond

public abstract void writeSecond(DataOutput out,
                                 B secondObject)
                          throws IOException

second object written to out

Parameters:

out -

secondObject -

Throws:

IOException

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out