Readable (DocFlex/Doclet 1.5 Demo

Interface Readable

public interface Readable

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

Since:

1.5

Version:

1.4 05/11/17

Method Summary
int	read(java.nio.CharBuffer cb) Attempts to read characters into the specified character buffer.

Method Detail

read

int read(java.nio.CharBuffer cb)
throws java.io.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:

cb - the buffer to read characters into

Returns:

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

Throws:

java.io.IOException - if an I/O error occurs

NullPointerException - if cb is null

ReadOnlyBufferException - if cb is a read only buffer

Java API documentation generated with DocFlex/Doclet v1.5.6

DocFlex/Doclet is both a multi-format Javadoc doclet and a free edition of DocFlex/Javadoc. If you need to customize your Javadoc without writing a full-blown doclet from scratch, DocFlex/Javadoc may be the only tool able to help you! Find out more at www.docflex.com