Package net.sf.mmm.util.io.api

Provides the API for utilities that help to read and write data, process bytes, etc.

See: Description

Interface Summary

Interface	Description
AsyncTransferrer	This is the interface for an async transferrer of streams or readers/writers.
ByteArray	This is the interface for some object that holds a byte-array together with a range where the user of this interface may start and end reading in that array.
ByteArrayBuffer	This is the interface for a byte[] buffer.
ByteBuffer	This is the interface for a buffer of bytes.
ByteIterator	This is the interface for an Iterator of byte -values.
ByteProcessable	This is the interface for an object providing data represented as sequence of bytes - typically some sort of buffer.
ByteProcessor	This is a call back interface that allows efficient processing of byte-buffers.
ByteProvider	This is an abstract interface for some object (typically some buffer) that provides bytes.
ComposedByteBuffer	This is the interface of a ByteBuffer that is internally composed out of multiple ByteArray s.
DetectorInputStream	This is the interface for a DetectorStream that wraps an InputStream.
DetectorOutputStream	This is the interface for a DetectorStream that wraps an OutputStream.
DetectorStream	This is the abstract base interface for a container of a wrapped stream together with metadata that is detected while streaming the data.
DetectorStreamProvider	This is the interface of a service that provides detector-streams.
EncodingUtil	This is the interface for a collection of utility functions to that help deal with encodings.
FileItem	This is the interface for a File.
ProcessableByteArrayBuffer	This is the interface for a provider of data bytes (a byte[] -Buffer) that is iterable and processable.
StreamUtil	This is the interface for a collection of utility functions that help to deal with InputStreams, OutputStreams, Readers and Writers.
TransferCallback	This is the callback interface used to receive the status of an AsyncTransferrer.

Class Summary

Class	Description
DevNullSource	This is an implementation of /dev/null as InputStream.
DevNullTarget	This is an implementation of /dev/null as OutputStream.
DevZero	This is an implementation of /dev/zero as InputStream.
EncodingDetectionReader	This class represents a Reader that automatically detects an encoding while reading the data.

Enum Summary

Enum	Description
ByteOrderMark	This type represents a Byte-Order-Mark (BOM) of an Unicode-Transformation-Format (UTF).
IoMode	This enum holds the possible modes of I/O.

Exception Summary

Exception	Description
BufferExceedException	A BufferExceedException is thrown if a buffer (typically array of bytes or chars) is exceeded (e.g.
RuntimeIoException	A RuntimeIoException is like an IOException but as a RuntimeException.
StreamClosedException	A StreamClosedException is thrown if a stream is used that has already been closed.

Package net.sf.mmm.util.io.api Description

Provides the API for utilities that help to read and write data, process bytes, etc.

IO-Util API

Dealing with java.io is NOT an easy task. This package provides utilities that make it easier to deal with InputStreams, OutputStreams, Readers and Writers as well as handling encodings. If a method specifies that a stream is closed, this is guaranteed on success as well as in an exceptional state so your server-application does NOT run out of file-handles.