Package nom.tam.util

Class InputDecoder

java.lang.Object

nom.tam.util.InputDecoder

Direct Known Subclasses:

FitsDecoder

public abstract class InputDecoder
extends Object

Efficient base class for decoding of binary input into Java arrays (primarily for internal use)

Since:

1.16

Author:

Attila Kovacs

See Also:

• OutputEncoder
• ArrayDataFile
• ArrayInputStream
• ArrayOutputStream

Constructor Summary

Constructors

Constructor	Description
InputDecoder(InputReader i)	Instantiates a new decoder for converting data representations into Java arrays.

Method Summary

Modifier and Type	Method	Description
abstract long	readArray(Object o)	See the contract of ArrayDataInput.readLArray(Object).
void	readArrayFully(Object o)	Based on readArray(Object), but guaranteeing a complete read of the supplied object or else an EOFException is thrown.
void	readImage(Object o)	Like readArrayFully(Object) but strictly for numerical types only.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InputDecoder

public InputDecoder(InputReader i)

Instantiates a new decoder for converting data representations into Java arrays.

Parameters:

i - the binary input.

Method Details

readArrayFully

public void readArrayFully(Object o)
                    throws IOException,
IllegalArgumentException

Based on readArray(Object), but guaranteeing a complete read of the supplied object or else an EOFException is thrown.

Parameters:

o - the array, including multi-dimensional, and heterogeneous arrays of arrays.

Throws:

EOFException - if already at the end of file.

IOException - if there was an IO error

IllegalArgumentException - if the argument is not a Java array, or is or contains elements that do not have supported conversions from binary representation.

See Also:

• readArray(Object)
• readImage(Object)

readArray

public abstract long readArray(Object o)
                        throws IOException,
IllegalArgumentException

See the contract of ArrayDataInput.readLArray(Object).

Parameters:

o - an array, to be populated

Returns:

the actual number of bytes read from the input, or -1 if already at the end-of-file.

Throws:

IllegalArgumentException - if the argument is not an array or if it contains an element that is not supported for decoding.

IOException - if there was an IO error reading from the input

See Also:

• readArrayFully(Object)

readImage

public void readImage(Object o)
               throws IOException,
IllegalArgumentException

Like readArrayFully(Object) but strictly for numerical types only.

Parameters:

o - An any-dimensional array containing only numerical types

Throws:

IllegalArgumentException - if the argument is not an array or if it contains an element that is not supported.

EOFException - if already at the end of file.

IOException - if there was an IO error

Since:

1.18

See Also:

• readArrayFully(Object)