Readable interface in Java

java.lang.Readable

A Readable is a source of characters. Characters from a Readable are made available to callers of the read method via a CharBuffer.

Implementing Classes:

BufferedReader

CharArrayReader

CharBuffer

FileReader

FilterReader

InputStreamReader

LineNumberReader

PipedReader

PushbackReader

Reader

StringReader

Declaration

import java.io.IOException;

public interface Readable {

    public int read(java.nio.CharBuffer cb) 
              throws IOException;
}

Methods

1. read(CharBuffer cb)

int java.lang.Readable.read(CharBuffer cb) throws IOException

Attempts to read characters into the specified character buffer. The buffer is used as a repository of characters as-is: the only changes made are the results of a put operation. No flipping or rewinding of the buffer is performed.

Parameters: One parameter is required for this method.

cb: the buffer to read characters into.

Returns: The number of char values added to the buffer, or -1 if this source of characters is at its end.

Throws:

1. IOException - if an I/O error occurs.

2. NullPointerException - if cb is null.

3. java.nio.ReadOnlyBufferException - if cb is a read-only buffer