Package loci.poi.util

Top-level util package are classes that are useful throughout the project.

See: Description

Interface Summary

Interface	Description
FixedField	behavior of a field at a fixed location within a byte array
LittleEndianConsts	a repository for constants shared by classes within this package

Class Summary

Class	Description
ArrayUtil	Utility classes for dealing with arrays.
BinaryTree	Red-Black tree-based implementation of Map.
BinaryTree.Node
BitField	Manage operations dealing with bit-mapped fields.
BitFieldFactory	Returns immutable Btfield instances.
BlockingInputStream	Implementation of a BlockingInputStream to provide data to RawDataBlock that expects data in 512 byte chunks.
ByteField	representation of a byte (8-bit) field at a fixed location within a byte array
CommonsLogger	A logger class that strives to make it as easy as possible for developers to write log calls, while simultaneously making those calls as cheap as possible by performing lazy evaluation of the log message.
DoubleList	A List of double's; as full an implementation of the java.util.List interface as possible, with an eye toward minimal creation of objects the mimicry of List is as follows: if possible, operations designated 'optional' in the List interface are attempted wherever the List interface refers to an Object, substitute double wherever the List interface refers to a Collection or List, substitute DoubleList the mimicry is not perfect, however: operations involving Iterators or ListIterators are not supported remove(Object) becomes removeValue to distinguish it from remove(int index) subList is not supported
DoubleList2d	Provides an interface for interacting with 2d arrays of doubles.
DrawingDump	Dump out the aggregated escher records
HexDump	dump data in hexadecimal format; derived from a HexDump utility I wrote in June 2001.
HexRead	Utilities to read hex from files.
IntegerField	representation of an integer (32-bit) field at a fixed location within a byte array
IntList	A List of int's; as full an implementation of the java.util.List interface as possible, with an eye toward minimal creation of objects the mimicry of List is as follows: if possible, operations designated 'optional' in the List interface are attempted wherever the List interface refers to an Object, substitute int wherever the List interface refers to a Collection or List, substitute IntList the mimicry is not perfect, however: operations involving Iterators or ListIterators are not supported remove(Object) becomes removeValue to distinguish it from remove(int index) subList is not supported
IntList2d	Provides an interface for interacting with 2d arrays of integers.
IntMapper	A List of objects that are indexed AND keyed by an int; also allows for getting the index of a value in the list
IOUtils
List2d	Provides an interface for interacting with 2d arrays of objects.
LittleEndian	a utility class for handling little-endian numbers, which the 80x86 world is replete with.
LongField	representation of a long (16-bit) field at a fixed location within a byte array
NullLogger	A logger class that strives to make it as easy as possible for developers to write log calls, while simultaneously making those calls as cheap as possible by performing lazy evaluation of the log message.
POILogFactory	Provides logging without clients having to mess with configuration/initialization.
POILogger	A logger interface that strives to make it as easy as possible for developers to write log calls, while simultaneously making those calls as cheap as possible by performing lazy evaluation of the log message.
ShortField	representation of a short (16-bit) field at a fixed location within a byte array
ShortList	A List of short's; as full an implementation of the java.util.List interface as possible, with an eye toward minimal creation of objects the mimicry of List is as follows: if possible, operations designated 'optional' in the List interface are attempted wherever the List interface refers to an Object, substitute short wherever the List interface refers to a Collection or List, substitute ShortList the mimicry is not perfect, however: operations involving Iterators or ListIterators are not supported remove(Object) becomes removeValue to distinguish it from remove(short index) subList is not supported
StringUtil	Title: String Utility Description: Collection of string handling utilities
SystemOutLogger	A logger class that strives to make it as easy as possible for developers to write log calls, while simultaneously making those calls as cheap as possible by performing lazy evaluation of the log message.
TempFile	Interface for creating temporary files.

Exception Summary

Exception	Description
LittleEndian.BufferUnderrunException	Exception to handle buffer underruns

Package loci.poi.util Description

Top-level util package are classes that are useful throughout the project. These classes are generally generic enough to be useful in any project and should be contributed elsewhere!

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:

• Apache POI Project