Package it.unimi.dsi.io
I/O classes.
Package Specification
Classes in this package fulfill needs that are not satisfied by the I/O classes available.
Reading text
We provide replacement classes such as FastBufferedReader
and classes exposing the lines of a file as a collection
or as an iterator. The general
WordReader
interface is used by
MG4J to provide customisable word segmentation.
Bit-level I/O
The standard Java API lacks bit-level I/O classes: to this purpose, we
provide InputBitStream
and OutputBitStream
, which can wrap any standard Java
corresponding stream and make it work at the bit level; moreover, they
provide support for several useful formats (such as unary, binary, minimal
binary, γ, δ and Golomb encoding).
Bit input and output streams offer also efficient buffering and a way to
reposition the bit stream in case the underlying byte stream is a
file-based stream or a RepositionableStream
.
Conventions
All coding methods work on natural numbers. The encoding of zero is very natural for some techniques, and much less natural for others. To keep methods rationally organised, all methods are able to encode any natural number. If, for instance, you want to write positive numbers in unary encoding and you do not want to waste a bit, you have to decrement them first (i.e., instead of p you must encode p−1).
-
Interface Summary Interface Description OfflineIterable.Serializer<A,B extends A> Determines a strategy to serialize and deserialize elements.SafelyCloseable A marker interface for a closeable resource that implements safety measures to make resource tracking easier.WordReader An interface providing methods to break the input from a reader into words. -
Class Summary Class Description ByteBufferInputStream A bridge between byte buffers and input streams.ByteDiskQueue A queue of bytes partially stored on disk.DebugInputBitStream A debugging wrapper for input bit streams.DebugOutputBitStream A debugging wrapper for output bit streams.DelimitedWordReader A word reader that breaks words on a given set of characters.FastBufferedReader A lightweight, unsynchronised buffered reader based on mutable strings.FileLinesCollection A wrapper exhibiting the lines of a file as aCollection
.FileLinesCollection.FileLinesIterator An iterator over the lines of aFileLinesCollection
.InputBitStream Bit-level input stream.LineIterator An adapter that exposes a fast buffered reader as an iterator over the returned lines.LineWordReader A trivialWordReader
that considers each line of a document a single word.MultipleInputStream A multiple input stream.NullInputStream End-of-stream-only input stream.NullOutputStream Throw-it-away output stream.NullReader End-of-stream-only reader.OfflineIterable<T,U extends T> An iterable that offers elements that were previously stored offline using specialized serialization methods.OfflineIterable.OfflineIterator<A,B extends A> An iterator returned by anOfflineIterable
.OutputBitStream Bit-level output stream.SegmentedInputStream Exhibits a singleInputStream
as a number of streams divided intoreset()
-separated segments.