it.tidalwave.role
Interface TextReadable

All Known Implementing Classes:

FileTextReadable

public interface TextReadable

The role of an object that can be read as a stream of characters.

Version:

$Id$

Author:

Fabrizio Giudici

Status: stable API

Field Summary

static TextReadable	DEFAULT A default implementation which throws IOException when opening the stream.
static java.lang.Class<TextReadable>	TextReadable

Method Summary

java.io.Reader

openReader() Returns a Reader to read from the object.

Field Detail

TextReadable

static final java.lang.Class<TextReadable> TextReadable

DEFAULT

static final TextReadable DEFAULT

A default implementation which throws IOException when opening the stream.

Method Detail

openReader

@Nonnull
java.io.Reader openReader()
                          throws java.io.IOException

Returns a Reader to read from the object.

Returns:

the Reader

Throws:

java.io.IOException - if the operation can't be performed