Apache POI - Common 5.3.0 · org.apache.poi.util · APIdia, the JavaDoc alternative

Modifier and Type	Interface and Description
public interface	DelayableLittleEndianOutput Implementors of this interface allow client code to 'delay' writing to a certain section of a data output stream.
public interface	FixedField behavior of a field at a fixed location within a byte array
public interface	LittleEndianConsts a repository for constants shared by classes within this package
public interface	LittleEndianInput
public interface	LittleEndianOutput
public interface	TempFileCreationStrategy Interface used by the `TempFile` utility class to create temporary files.

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

Class Summary

Modifier and Type	Class and Description
public class	ArrayUtil Utility classes for dealing with arrays.
public class	BitField Manage operations dealing with bit-mapped fields.
public class	BitFieldFactory Returns immutable Bitfield instances.
public class	ByteField representation of a byte (8-bit) field at a fixed location within a byte array
public class	CodePageUtil Utilities for working with Microsoft CodePages.
public class	CodepointsUtil
public class	Configurator Helper for fetching int values from system properties
public class	DefaultTempFileCreationStrategy Default implementation of the `TempFileCreationStrategy` used by `TempFile`: Files are collected into one directory and by default are deleted on exit from the VM.
public class	Dimension2DDouble
public class	DocumentFormatException This is similar to `RecordFormatException`, except this is thrown when there's a higher order problem with parsing a document beyond individual records.
public class	DrawingDump Dump out the aggregated escher records
public class	ExceptionUtil Utility methods for dealing with exceptions/throwables
public class	FontMetricsDumper
public class	GenericRecordJsonWriter
public class	GenericRecordUtil
public class	GenericRecordXmlWriter
public class	HexDump dump data in hexadecimal format
public class	HexRead Utilities to read hex from files.
public class	IntegerField representation of an integer (32-bit) field at a fixed location within a byte array
public class	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
public class	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 I am happy is someone wants to re-implement this without using the internal list and hashmap.
public class	IOUtils
public class	LittleEndian a utility class for handling little-endian numbers, which the 80x86 world is replete with.
public class	LittleEndianByteArrayInputStream Adapts a plain byte array to `LittleEndianInput`
public class	LittleEndianByteArrayOutputStream Adapts a plain byte array to `LittleEndianOutput`
public class	LittleEndianInputStream Wraps an `InputStream` providing `LittleEndianInput` This class does not buffer any input, so the stream read position maintained by this class is consistent with that of the inner stream.
public class	LittleEndianOutputStream
public class	LocaleUtil This utility class is used to set locale and time zone settings beside of the JDK internal `java.util.Locale#setDefault(Locale)` and `java.util.TimeZone#setDefault(TimeZone)` methods, because the locale/time zone specific handling of certain office documents - maybe for different time zones / locales ...
public class	LongField representation of a long (16-bit) field at a fixed location within a byte array
public abstract class	LZWDecompresser This class provides common functionality for the various LZW implementations in the different file formats.
public class	RandomSingleton
public class	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.
public class	ReplacingInputStream Simple FilterInputStream that can replace occurrences of bytes with something else.
public class	RLEDecompressingInputStream Wrapper of InputStream which provides Run Length Encoding (RLE) decompression on the fly.
public class	ShortField representation of a short (16-bit) field at a fixed location within a byte array
public class	StaxHelper Deprecated use `XMLHelper` Provides handy methods for working with StAX parsers and readers
public class	StringUtil Collection of string handling utilities
public class	TempFile Interface for creating temporary files.
public class	ThreadLocalUtil Small utility to allow to remove references held in ThreadLocals.
public class	Units
public class	XMLHelper Helper methods for working with javax.xml classes.

Package org.apache.poi.util

Interface Summary

Annotation Summary

Class Summary

Enum Summary