Package nom.tam.util

package nom.tam.util

Various commonly used classes for nom-tam-fits. Many of its classes are intended promarily for internal use within the library. It's a bit of catch-all package with all sort of classes thrown in here. Some of these would have had a more natural home in the other packages. A large part of this package provides the IO support for nom-tam-fits, which probably should have deserved its own package. But this is what we have, and we are going to stick with it.

Related Packages

Package	Description
nom.tam.util.array	A few classes for copying and iterating over multi-dimensional arrays of all/any types, primarily for internal use.
nom.tam.util.type	(for internal use) FITS 'primitive' element types.

Class	Description
ArrayDataFile	Efficient reading and writing of arrays to and from files, with custom encoding.
ArrayDataInput	Interface for reading array data from inputs.
ArrayDataOutput	Interface for writing array data to outputs.
ArrayFuncs	(for internal use) Varioys static functions for handling arrays.
ArrayInputStream	Efficient reading of binary arrays from streams with custom binary encoding.
ArrayOutputStream	Efficient writing of binary arrays to streams with custom binary encoding.
AsciiFuncs	(for internal use) Various static functios to handle ASCII sequences
BufferDecoder	Deprecated. Use FitsDecoder instead which provides a similar function but in a more consistent way and with a less misleading name.
BufferedDataInputStream	Deprecated. Use FitsInputStream instead which provides the same functionality with a less misleading name, or else use ArrayInputStream as a base for a more generic implementation for any (non-FITS) encoding.
BufferedDataOutputStream	Deprecated. Use FitsOutputStream, which provides the exact same functionality but with a less misleading name, or else use ArrayOutputStream as a base for an implementation with any (non-FITS) encoding.
BufferedFile	Deprecated. Use FitsFile instead, which replaces the old BufferedFile with a less misleading name, or else ArrayDataFile, which provides a base for a more more generic implementation for efficient reading/writing arrays using any (non-FITS) encoding.
BufferEncoder	Deprecated. Use FitsEncoder instead which provides a similar function but in a more consistent way and with a less misleading name.
BufferPointer	Deprecated. (for internal use) It is a rusty-rail compatibility implementation only, unsafe for general use.
ByteArrayIO	Reading from and writing to byte arrays with a stream-like interface (primarily for internal use) .
ByteBufferInputStream	Stream interface for reading from a ByteBuffer (primarily for internal use)
ByteBufferOutputStream	Stream interface for writing to a ByteBuffer (primarily for internal use)
ByteFormatter	Deprecated. This class should not be exposed in the public API and is intended for internal use only in ASCII tables.
ByteParser	Deprecated. This class should not be exposed in the public API and is intended for internal use only in ASCII tables.
ColumnTable<T>	Table data that is stored (internally) in column major format.
ComplexValue	A no-frills complex value, for representing complex numbers in FITS headers.
ComplexValue.Float	Just a class we can refer to when we want to specify that we want to use single-precision complex values.
Cursor<KEY,VALUE>	An Iterator-based interface for key / value pairs allowing insertions and reverse movement also.
CursorValue<T>	Interface for cursor-based access to keys
DataTable	A non FITS-specific interface for generic table data access.
FitsDecoder	Decodes FITS-formatted binary data into Java arrays (primarily for internal use)
FitsEncoder	Encodes select Java arrays into FITS binary format (primarily for internal use)
FitsFile	For reading and writing FITS files.
FitsInputStream	For reading FITS files through an InputStream.
FitsIO	Base interface for reading and writing FITS.
FitsOutput	Interface for FITS-specific output.
FitsOutputStream	For writing FITS files through an OutputStream.
FlexFormat	Formatting number values for use in FITS headers.
FormatException	Exception that is thrown if values do not appear in the format they are expected.
HashedList<VALUE extends CursorValue<String>>	An ordered hash map implementation.
InputDecoder	Efficient base class for decoding of binary input into Java arrays (primarily for internal use)
InputReader	Interface for asic binary input reading functionality.
LoggerHelper	Access to Logger instances by class.
OutputEncoder	Efficient base class for encoding Java arrays into binary output (primarily for internal use)
OutputWriter	Interface for basic binary output writing functionality.
RandomAccess	Interface that combines file-based random acesss with high-throughput array IO
RandomAccessFileIO	Interface for IO objects that support file-like random access.
ReadWriteAccess	Interface for basic random access read and write operations.
SafeClose	Deprecated. Use try-with-resources constructs of Java 8+ instead.
TableException	For when attempting to do something illegal or invalid with FITS tables.