com.aquenos.epics.jackie.common.io

Class AbstractByteSource

java.lang.Object

com.aquenos.epics.jackie.common.io.AbstractByteSource

All Implemented Interfaces:

ByteSource

Direct Known Subclasses:

ByteBufferByteSource

public abstract class AbstractByteSource
extends Object
implements ByteSource

Abstract base class for classes implementing ByteSource. This class implements some common methods that most classes will not want to override. In particular, it maps all get methods without an offset to their counterpart with an offset, so that the number of methods to implement is reduced.

Author:

Sebastian Marsching

Nested Class Summary

Nested classes/interfaces inherited from interface com.aquenos.epics.jackie.common.io.ByteSource

ByteSource.AtomicGetOperation<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	SIZE_OF_BYTE Size of a byte in bytes.
protected static int	SIZE_OF_DOUBLE Size of a double in bytes.
protected static int	SIZE_OF_FLOAT Size of a float in bytes.
protected static int	SIZE_OF_INT Size of an int in bytes.
protected static int	SIZE_OF_LONG Size of a long in bytes.
protected static int	SIZE_OF_SHORT Size of a short in bytes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractByteSource() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
byte	getByte() Reads a single byte and advances the current position.
byte[]	getByteArray(int length) Reads the specified number of bytes and advances the current position.
double	getDouble() Reads a single double and advances the current position.
AbstractByteSource	getDoubleArray(double[] destination, int offset, int length) Reads the specified number of double values into the supplied array and advances the current position.
double[]	getDoubleArray(int length) Reads the specified number of doubles and advances the current position.
float	getFloat() Reads a single float and advances the current position.
AbstractByteSource	getFloatArray(float[] destination, int offset, int length) Reads the specified number of float values into the supplied array and advances the current position.
float[]	getFloatArray(int length) Reads the specified number of floats and advances the current position.
int	getInt() Reads a single int and advances the current position.
int[]	getIntArray(int length) Reads the specified number of ints and advances the current position.
AbstractByteSource	getIntArray(int[] destination, int offset, int length) Reads the specified number of int values into the supplied array and advances the current position.
long	getLong() Reads a single long and advances the current position.
long[]	getLongArray(int length) Reads the specified number of longs and advances the current position.
AbstractByteSource	getLongArray(long[] destination, int offset, int length) Reads the specified number of long values into the supplied array and advances the current position.
short	getShort() Reads a single short and advances the current position.
short[]	getShortArray(int length) Reads the specified number of shorts and advances the current position.
AbstractByteSource	getShortArray(short[] destination, int offset, int length) Reads the specified number of short values into the supplied array and advances the current position.
String	toString() Returns a string representation of this byte source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.aquenos.epics.jackie.common.io.ByteSource

atomicGet, getByteArray, remaining, skip

Field Detail

SIZE_OF_BYTE

protected static final int SIZE_OF_BYTE

Size of a byte in bytes.

See Also:

Constant Field Values

SIZE_OF_DOUBLE

protected static final int SIZE_OF_DOUBLE

Size of a double in bytes.

See Also:

Constant Field Values

SIZE_OF_FLOAT

protected static final int SIZE_OF_FLOAT

Size of a float in bytes.

See Also:

Constant Field Values

SIZE_OF_INT

protected static final int SIZE_OF_INT

Size of an int in bytes.

See Also:

Constant Field Values

SIZE_OF_LONG

protected static final int SIZE_OF_LONG

Size of a long in bytes.

See Also:

Constant Field Values

SIZE_OF_SHORT

protected static final int SIZE_OF_SHORT

Size of a short in bytes.

See Also:

Constant Field Values

Constructor Detail

AbstractByteSource

protected AbstractByteSource()

Default constructor. This constructor is supposed to be used by classes that inherit from this class.

Method Detail

getByte

public byte getByte()

Description copied from interface: ByteSource

Reads a single byte and advances the current position.

Specified by:

getByte in interface ByteSource

Returns:

single byte read from the current position.

getByteArray

public byte[] getByteArray(int length)

Description copied from interface: ByteSource

Reads the specified number of bytes and advances the current position. This is effectively the same as this.getByteArray(new byte[length], 0, length).

Specified by:

getByteArray in interface ByteSource

Parameters:

length - number of bytes to be read.

Returns:

array with the specified length and containing bytes read from the source starting at the current position.

getDouble

public double getDouble()

Description copied from interface: ByteSource

Reads a single double and advances the current position.

Specified by:

getDouble in interface ByteSource

Returns:

single double read from the current position.

getDoubleArray

public double[] getDoubleArray(int length)

Description copied from interface: ByteSource

Reads the specified number of doubles and advances the current position. This is effectively the same as this.getDoubleArray(new double[length], 0, length).

Specified by:

getDoubleArray in interface ByteSource

Parameters:

length - number of doubles to be read.

Returns:

array with the specified length and containing doubles read starting at the current position.

getDoubleArray

public AbstractByteSource getDoubleArray(double[] destination,
                                int offset,
                                int length)

Description copied from interface: ByteSource

Reads the specified number of double values into the supplied array and advances the current position.

Specified by:

getDoubleArray in interface ByteSource

Parameters:

destination - array into which the read values are copied. This array's length must be at least length + destinationOffset.

offset - offset into the destination array. The destination array is filled starting at this position.

length - number of values to be read.

Returns:

a reference to this byte source.

getFloat

public float getFloat()

Description copied from interface: ByteSource

Reads a single float and advances the current position.

Specified by:

getFloat in interface ByteSource

Returns:

single float read from the current position.

getFloatArray

public float[] getFloatArray(int length)

Description copied from interface: ByteSource

Reads the specified number of floats and advances the current position. This is effectively the same as this.getFloatArray(new float[length], 0, length).

Specified by:

getFloatArray in interface ByteSource

Parameters:

length - number of floats to be read.

Returns:

array with the specified length and containing floats read starting at the current position.

getFloatArray

public AbstractByteSource getFloatArray(float[] destination,
                               int offset,
                               int length)

Description copied from interface: ByteSource

Reads the specified number of float values into the supplied array and advances the current position.

Specified by:

getFloatArray in interface ByteSource

Parameters:

destination - array into which the read values are copied. This array's length must be at least length + destinationOffset.

offset - offset into the destination array. The destination array is filled starting at this position.

length - number of values to be read.

Returns:

a reference to this byte source.

getInt

public int getInt()

Description copied from interface: ByteSource

Reads a single int and advances the current position.

Specified by:

getInt in interface ByteSource

Returns:

single int read from the current position.

getIntArray

public int[] getIntArray(int length)

Description copied from interface: ByteSource

Reads the specified number of ints and advances the current position. This is effectively the same as this.getIntArray(new int[length], 0, length).

Specified by:

getIntArray in interface ByteSource

Parameters:

length - number of ints to be read.

Returns:

array with the specified length and containing ints read starting at the current position.

getIntArray

public AbstractByteSource getIntArray(int[] destination,
                             int offset,
                             int length)

Description copied from interface: ByteSource

Reads the specified number of int values into the supplied array and advances the current position.

Specified by:

getIntArray in interface ByteSource

Parameters:

destination - array into which the read values are copied. This array's length must be at least length + destinationOffset.

offset - offset into the destination array. The destination array is filled starting at this position.

length - number of values to be read.

Returns:

a reference to this byte source.

getLong

public long getLong()

Description copied from interface: ByteSource

Reads a single long and advances the current position.

Specified by:

getLong in interface ByteSource

Returns:

single long read from the current position.

getLongArray

public long[] getLongArray(int length)

Description copied from interface: ByteSource

Reads the specified number of longs and advances the current position. This is effectively the same as this.getLongArray(new long[length], 0, length).

Specified by:

getLongArray in interface ByteSource

Parameters:

length - number of longs to be read.

Returns:

array with the specified length and containing longs read starting at the current position.

getLongArray

public AbstractByteSource getLongArray(long[] destination,
                              int offset,
                              int length)

Description copied from interface: ByteSource

Reads the specified number of long values into the supplied array and advances the current position.

Specified by:

getLongArray in interface ByteSource

Parameters:

destination - array into which the read values are copied. This array's length must be at least length + destinationOffset.

offset - offset into the destination array. The destination array is filled starting at this position.

length - number of values to be read.

Returns:

a reference to this byte source.

getShort

public short getShort()

Description copied from interface: ByteSource

Reads a single short and advances the current position.

Specified by:

getShort in interface ByteSource

Returns:

single short read from the current position.

getShortArray

public short[] getShortArray(int length)

Description copied from interface: ByteSource

Reads the specified number of shorts and advances the current position. This is effectively the same as this.getShortArray(new short[length], 0, length).

Specified by:

getShortArray in interface ByteSource

Parameters:

length - number of shorts to be read.

Returns:

array with the specified length and containing shorts read starting at the current position.

getShortArray

public AbstractByteSource getShortArray(short[] destination,
                               int offset,
                               int length)

Description copied from interface: ByteSource

Reads the specified number of short values into the supplied array and advances the current position.

Specified by:

getShortArray in interface ByteSource

Parameters:

destination - array into which the read values are copied. This array's length must be at least length + destinationOffset.

offset - offset into the destination array. The destination array is filled starting at this position.

length - number of values to be read.

Returns:

a reference to this byte source.

toString

public String toString()

Returns a string representation of this byte source. The string representation contains the number of bytes remaining in this source and the values of the first 1024 bytes remaining in this source in a hexadecimal representation.

Overrides:

toString in class Object

Returns:

string representation of this byte source.