Package org.apache.commons.io.input
Provides implementations of input classes, such as
InputStream
and Reader
.-
Interface Summary Interface Description Tailer.RandomAccessResourceBridge Bridges access to a resource for random access, normally a file.Tailer.Tailable A tailable resource like a file.TailerListener Listener for events from aTailer
. -
Class Summary Class Description AbstractCharacterFilterReader A filter reader that filters out characters where subclasses decide which characters to filter out.AutoCloseInputStream Proxy stream that closes and discards the underlying stream as soon as the end of input has been reached or when the stream is explicitly closed.AutoCloseInputStream.Builder Builds a newAutoCloseInputStream
instance.BOMInputStream This class is used to wrap a stream that includes an encodedByteOrderMark
as its first bytes.BOMInputStream.Builder Builds a newBOMInputStream
instance.BoundedInputStream Reads bytes up to a maximum length, if its count goes above that, it stops.BoundedReader A reader that imposes a limit to the number of characters that can be read from an underlying reader, returning EOF when this limit is reached, regardless of state of underlying reader.BrokenInputStream Always throws anIOException
from all theInputStream
methods where the exception is declared.BrokenReader Always throws anIOException
from all theReader
methods where the exception is declared.BufferedFileChannelInputStream InputStream
implementation which uses direct buffer to read a file to avoid extra copy of data between Java and native memory which happens when usingBufferedInputStream
.BufferedFileChannelInputStream.Builder Builds a newBufferedFileChannelInputStream
instance.CharacterFilterReader A filter reader that filters out a given character represented as anint
code point, handy to remove known junk characters from CSV files for example.CharacterSetFilterReader A filter reader that removes a given set of characters represented asint
code points, handy to remove known junk characters from CSV files for example.CharSequenceInputStream Implements anInputStream
to read from String, StringBuffer, StringBuilder or CharBuffer.CharSequenceInputStream.Builder Builds a newCharSequenceInputStream
instance.CharSequenceReader Reader
implementation that can read from String, StringBuffer, StringBuilder or CharBuffer.CircularInputStream AnInputStream
that repeats provided bytes for given target byte count.ClassLoaderObjectInputStream A special ObjectInputStream that loads a class based on a specifiedClassLoader
rather than the system default.ClosedInputStream Always returnsIOUtils.EOF
to all attempts to read something from the stream.ClosedReader Always returnsIOUtils.EOF
to all attempts to read something from it.CloseShieldInputStream Proxy stream that prevents the underlying input stream from being closed.CloseShieldReader Proxy reader that prevents the underlying reader from being closed.CountingInputStream A decorating input stream that counts the number of bytes that have passed through the stream so far.DemuxInputStream Data written to this stream is forwarded to a stream that has been associated with this thread.InfiniteCircularInputStream AnInputStream
that infinitely repeats the provided bytes.MarkShieldInputStream This is an alternative toByteArrayInputStream
which removes the synchronization overhead for non-concurrent access; as such this class is not thread-safe.MemoryMappedFileInputStream AnInputStream
that utilizes memory mapped files to improve performance.MemoryMappedFileInputStream.Builder Builds a newMemoryMappedFileInputStream
instance.MessageDigestCalculatingInputStream This class is an example for using anObservableInputStream
.MessageDigestCalculatingInputStream.Builder Builds a newMessageDigestCalculatingInputStream
instance.MessageDigestCalculatingInputStream.MessageDigestMaintainingObserver Maintains the message digest.NullInputStream A functional, light weightInputStream
that emulates a stream of a specified size.NullReader A functional, light weightReader
that emulates a reader of a specified size.ObservableInputStream TheObservableInputStream
allows, that an InputStream may be consumed by other receivers, apart from the thread, which is reading it.ObservableInputStream.Observer Abstracts observer callback forObservableInputStream
s.ProxyInputStream A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.ProxyReader A Proxy stream which acts as expected, that is it passes the method calls on to the proxied stream and doesn't change which methods are being called.QueueInputStream Simple alternative to JDKPipedInputStream
; queue input stream provides what's written in queue output stream.QueueInputStream.Builder Builds a newQueueInputStream
instance.RandomAccessFileInputStream Streams data from aRandomAccessFile
starting at its current position.RandomAccessFileInputStream.Builder Builds a newRandomAccessFileInputStream
instance.ReadAheadInputStream ImplementsInputStream
to asynchronously read ahead from an underlying input stream when a specified amount of data has been read from the current buffer.ReadAheadInputStream.Builder Builds a newReadAheadInputStream
instance.ReaderInputStream InputStream
implementation that reads a character stream from aReader
and transforms it to a byte stream using a specified charset encoding.ReaderInputStream.Builder Builds a newReaderInputStream
instance.ReversedLinesFileReader Reads lines in a file reversely (similar to a BufferedReader, but starting at the last line).ReversedLinesFileReader.Builder Builds a newReversedLinesFileReader
instance.SequenceReader Provides the contents of multipleReader
s in sequence.SwappedDataInputStream DataInput for systems relying on little endian data formats.TaggedInputStream An input stream decorator that tags potential exceptions so that the stream that caused the exception can easily be identified.TaggedReader A reader decorator that tags potential exceptions so that the reader that caused the exception can easily be identified.Tailer Simple implementation of the UNIX "tail -f" functionality.Tailer.Builder Builds aTailer
with default values.TailerListenerAdapter TailerListener
Adapter.TeeInputStream InputStream proxy that transparently writes a copy of all bytes read from the proxied stream to a given OutputStream.TeeReader Reader proxy that transparently writes a copy of all characters read from the proxied reader to a given Reader.TimestampedObserver An observer with timestamps.UncheckedBufferedReader ABufferedReader
that throwsUncheckedIOException
instead ofIOException
.UncheckedBufferedReader.Builder Builds a newUncheckedBufferedReader
instance.UncheckedFilterInputStream ABufferedReader
that throwsUncheckedIOException
instead ofIOException
.UncheckedFilterInputStream.Builder Builds a newUncheckedFilterInputStream
instance.UncheckedFilterReader AFilterReader
that throwsUncheckedIOException
instead ofIOException
.UncheckedFilterReader.Builder Builds a newUncheckedFilterReader
instance.UnixLineEndingInputStream A filtering input stream that ensures the content will have UNIX-style line endings, LF.UnsynchronizedBufferedInputStream An unsynchronized version ofBufferedInputStream
, not thread-safe.UnsynchronizedBufferedInputStream.Builder Builds a newUnsynchronizedBufferedInputStream
instance.UnsynchronizedByteArrayInputStream This is an alternative toByteArrayInputStream
which removes the synchronization overhead for non-concurrent access; as such this class is not thread-safe.UnsynchronizedByteArrayInputStream.Builder Builds a newUnsynchronizedByteArrayInputStream
instance.UnsynchronizedFilterInputStream An unsynchronized version ofFilterInputStream
, not thread-safe.UnsynchronizedFilterInputStream.Builder Builds a newUnsynchronizedFilterInputStream
instance.WindowsLineEndingInputStream A filtering input stream that ensures the content will have Windows line endings, CRLF.XmlStreamReader Character stream that handles all the necessary Voodoo to figure out the charset encoding of the XML document within the stream.XmlStreamReader.Builder Builds a newXmlStreamWriter
instance. -
Exception Summary Exception Description XmlStreamReaderException The XmlStreamReaderException is thrown by the XmlStreamReader constructors if the charset encoding can not be determined according to the XML 1.0 specification and RFC 3023.