org.openimaj.io

Interface InputStreamObjectReader<T>

Type Parameters:

T - Type of object being read.

All Superinterfaces:

ObjectReader<T,InputStream>

All Known Implementing Classes:

OneSecondClipReader

public interface InputStreamObjectReader<T>
extends ObjectReader<T,InputStream>

Interface for classes capable of reading objects from a InputStream.

Author:

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

Method Summary

Modifier and Type	Method and Description
boolean	canRead(InputStream stream, String name) Returns true if the stream can be read, or false otherwise.

Methods inherited from interface org.openimaj.io.ObjectReader

read

Method Detail

canRead

boolean canRead(InputStream stream,
                String name)

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

Typically implementations will read just the first few bytes from the stream to determine if the data can be read. This method is not normally called directly; rather, IOUtils.canRead(InputStreamObjectReader, java.io.BufferedInputStream, String) should be used instead as it is capable of resetting the stream to its initial condition.

Specified by:

canRead in interface ObjectReader<T,InputStream>

Parameters:

stream - the input stream

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

Returns:

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

See Also:

IOUtils.canRead(InputStreamObjectReader, java.io.BufferedInputStream, String)