org.openimaj.io

Interface ObjectReader<T,SOURCE>

Type Parameters:

T - Type of object being read.

SOURCE - The type of the source of data for the object being read

All Known Subinterfaces:

InputStreamObjectReader<T>

All Known Implementing Classes:

OneSecondClipReader, VFSListDataset.FileObjectISReader

public interface ObjectReader<T,SOURCE>

Interface for classes capable of reading objects.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
boolean	canRead(SOURCE source, String name) Returns true if the stream can be read, or false otherwise.
T	read(SOURCE source) Read an object from the source

Method Detail

read

T read(SOURCE source)
throws IOException

Read an object from the source

Parameters:

source - the source

Returns:

the object

Throws:

IOException - if an error occurs

canRead

boolean canRead(SOURCE source,
                String name)

Returns true if the stream can be read, or false otherwise.

This method is not normally called directly; rather, IOUtils.canRead(ObjectReader, Object, String) should be used instead.

Parameters:

source - the data source

name - the name of the file behind the stream (can be null).

Returns:

true if this ObjectReader can read the stream; false otherwise.

See Also:

IOUtils.canRead(ObjectReader, Object, String)