Package it.tidalwave.role.io.spi

Class PathTextReadable

java.lang.Object

it.tidalwave.role.io.spi.PathTextReadable

All Implemented Interfaces:

TextReadable

public class PathTextReadable
extends Object
implements TextReadable

An implementation of TextReadable which delegates to a Path.

Since:

3.2-ALPHA-12

Author:

Fabrizio Giudici

Status: stable API

Field Summary

Fields inherited from interface it.tidalwave.role.io.TextReadable

_TextReadable_, DEFAULT

Constructor Summary

Constructors

Constructor	Description
PathTextReadable(Path path)	Creates an instance with the given path and options.
PathTextReadable(Path path, Charset charset)	Creates an instance with the given path and options.

Method Summary

Modifier and Type	Method	Description
Reader	openReader()	Returns a Reader to read from the object.

Methods inherited from class java.lang.Object

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

Constructor Details

PathTextReadable

public PathTextReadable(@Nonnull
 Path path)

Creates an instance with the given path and options.

Parameters:

path - the path to open

PathTextReadable

public PathTextReadable(@Nonnull
 Path path,
 @Nonnull
 Charset charset)

Creates an instance with the given path and options.

Parameters:

path - the path to open

charset - the character set

Method Details

openReader

@Nonnull
public Reader openReader()
                  throws IOException

Returns a Reader to read from the object.

Specified by:

openReader in interface TextReadable

Returns:

the Reader

Throws:

IOException - if the operation can't be performed