org.apache.tools.ant.util

Class ReaderInputStream

java.lang.Object

java.io.InputStream

org.apache.tools.ant.util.ReaderInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

StringInputStream

public class ReaderInputStream
extends InputStream

Adapts a Reader as an InputStream. Adapted from StringInputStream.

Constructor Summary

Constructors

Constructor and Description
ReaderInputStream(Reader reader) Construct a ReaderInputStream for the specified Reader.
ReaderInputStream(Reader reader, String encoding) Construct a ReaderInputStream for the specified Reader, with the specified encoding.

Method Summary

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	close() Closes the Reader.
void	mark(int limit) Marks the read limit of the Reader.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
int	read() Reads from the Reader, returning the same value.
int	read(byte[] b, int off, int len) Reads from the Reader into a byte array
void	reset() Resets the Reader.

Methods inherited from class java.io.InputStream

read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ReaderInputStream

public ReaderInputStream(Reader reader)

Construct a ReaderInputStream for the specified Reader.

Parameters:

reader - Reader. Must not be null.

ReaderInputStream

public ReaderInputStream(Reader reader,
                         String encoding)

Construct a ReaderInputStream for the specified Reader, with the specified encoding.

Parameters:

reader - non-null Reader.

encoding - non-null String encoding.

Method Detail

available

public int available()
              throws IOException

Description copied from class: InputStream

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass' implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the InputStream.close() method.

The available method for class InputStream always returns 0.

This method should be overridden by subclasses.

Overrides:

available in class InputStream

Returns:

the current number of bytes ready for reading

Throws:

IOException - if an error occurs

close

public void close()
           throws IOException

Closes the Reader.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if the original Reader fails to be closed

mark

public void mark(int limit)

Marks the read limit of the Reader.

Overrides:

mark in class InputStream

Parameters:

limit - the maximum limit of bytes that can be read before the mark position becomes invalid

See Also:

InputStream.reset()

markSupported

public boolean markSupported()

Description copied from class: InputStream

Tests if this input stream supports the mark and reset methods. Whether or not mark and reset are supported is an invariant property of a particular input stream instance. The markSupported method of InputStream returns false.

Overrides:

markSupported in class InputStream

Returns:

false - mark is not supported

See Also:

InputStream.mark(int), InputStream.reset()

read

public int read()
         throws IOException

Reads from the Reader, returning the same value.

Specified by:

read in class InputStream

Returns:

the value of the next character in the Reader.

Throws:

IOException - if the original Reader fails to be read

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Reads from the Reader into a byte array

Overrides:

read in class InputStream

Parameters:

b - the byte array to read into

off - the offset in the byte array

len - the length in the byte array to fill

Returns:

the actual number read into the byte array, -1 at the end of the stream

Throws:

IOException - if an error occurs

See Also:

InputStream.read()

reset

public void reset()
           throws IOException

Resets the Reader.

Overrides:

reset in class InputStream

Throws:

IOException - if the Reader fails to be reset

See Also:

InputStream.mark(int), IOException