org.netbeans.api.extexecution.base.input

Interface InputReader

All Superinterfaces:

AutoCloseable, Closeable

public interface InputReader
extends Closeable, AutoCloseable

This interface represents abstraction for reading characters. It allows custom processing of such characters through the given processor.

For safe usage in InputReaderTask implementation of this interface has to be responsive to interruption.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader releasing the resources held by it.
int	readInput(InputProcessor processor) Reads some input and process it through the processor (if any).

Method Detail

readInput

int readInput(@NullAllowed
              InputProcessor processor)
       throws IOException

Reads some input and process it through the processor (if any).

Implementation of this method has to be non blocking for safe usage in InputReaderTask.

Parameters:

processor - consumer of read characters, may be null

Returns:

number of characters read

Throws:

IOException - if any read or process error occurs

close

void close()
    throws IOException

Closes the reader releasing the resources held by it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if error occurs while closing