Package org.apache.poi.util

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!

Interface Summary

Interface	Description
DelayableLittleEndianOutput	Implementors of this interface allow client code to 'delay' writing to a certain section of a data output stream. A typical application is for writing BIFF records when the size is not known until well after the header has been written.
FixedField	behavior of a field at a fixed location within a byte array
GenericRecordJsonWriter.GenericRecordHandler
GenericRecordXmlWriter.GenericRecordHandler
LittleEndianConsts	a repository for constants shared by classes within this package
LittleEndianInput
LittleEndianOutput
TempFileCreationStrategy	Interface used by the TempFile utility class to create temporary files.

Class Summary

Class	Description
ArrayUtil	Utility classes for dealing with arrays.
BitField	Manage operations dealing with bit-mapped fields.
BitFieldFactory	Returns immutable Bitfield instances.
ByteField	representation of a byte (8-bit) field at a fixed location within a byte array
CodePageUtil	Utilities for working with Microsoft CodePages.
CodepointsUtil
Configurator	Helper for fetching int values from system properties
DateTimeFormatUtils	Utils for Datetime, since locale provider has changed from java 9.
DefaultTempFileCreationStrategy	Default implementation of the TempFileCreationStrategy used by TempFile: Files are collected into one directory.
Dimension2DDouble
DrawingDump	Dump out the aggregated escher records
ExceptionUtil	Utility methods for dealing with exceptions/throwables
FontMetricsDumper
GenericRecordJsonWriter
GenericRecordUtil
GenericRecordUtil.AnnotatedFlag
GenericRecordXmlWriter
HexDump	dump data in hexadecimal format
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.
IntMapper<T>	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
LittleEndian	a utility class for handling little-endian numbers, which the 80x86 world is replete with.
LittleEndianByteArrayInputStream	Adapts a plain byte array to LittleEndianInput
LittleEndianByteArrayOutputStream	Adapts a plain byte array to LittleEndianOutput
LittleEndianInputStream	Wraps an InputStream providing LittleEndianInput
LittleEndianOutputStream
LocaleUtil	This utility class is used to set locale and time zone settings beside of the JDK internal Locale.setDefault(Locale) and TimeZone.setDefault(TimeZone) methods, because the locale/time zone specific handling of certain office documents - maybe for different time zones / locales ... - shouldn't affect other java components.
LongField	representation of a long (16-bit) field at a fixed location within a byte array
LZWDecompresser	This class provides common functionality for the various LZW implementations in the different file formats.
RandomSingleton
ReplacingInputStream	Simple FilterInputStream that can replace occurrences of bytes with something else.
Reproducibility	Helper class for allowing to produce so called "reproducible" output.
RLEDecompressingInputStream	Wrapper of InputStream which provides Run Length Encoding (RLE) decompression on the fly.
ShortField	representation of a short (16-bit) field at a fixed location within a byte array
StaxHelper	Deprecated. use XMLHelper
StringUtil	Collection of string handling utilities
TempFile	Interface for creating temporary files.
ThreadLocalUtil	Small utility to allow to remove references held in ThreadLocals.
Units
UserNameAwareTempFileCreationStrategy	Username-aware subclass of DefaultTempFileCreationStrategy that avoids permission issues when deploying applications with multiple users on the same server.
XMLHelper	Helper methods for working with javax.xml classes.

Enum Summary

Enum	Description
LocaleID	Locale Collection

Exception Summary

Exception	Description
DocumentFormatException	This is similar to RecordFormatException, except this is thrown when there's a higher order problem with parsing a document beyond individual records.
LittleEndian.BufferUnderrunException	Exception to handle buffer underruns
RecordFormatException	A common exception thrown by our binary format parsers (especially HSSF and DDF), when they hit invalid format or data when processing a record.

Annotation Types Summary

Annotation Type	Description
Beta	Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.
Internal	Program elements annotated @Internal are intended for POI internal use only.
NotImplemented	This feature has not been implemented yet.
Removal	Program elements annotated @Removal track the earliest final release when a deprecated feature will be removed.
SuppressForbidden	Marking class for elements to be ignored by the forbidden apis check