com.aquenos.epics.jackie.common.io

Class AbstractByteSink

java.lang.Object

com.aquenos.epics.jackie.common.io.AbstractByteSink

All Implemented Interfaces:

ByteSink

Direct Known Subclasses:

ByteBufferByteSink

public abstract class AbstractByteSink
extends Object
implements ByteSink

Abstract base class for ByteSink implementations. This base class implements most of the methods declared in the ByteSink interface. However, the typed put operations in this class incur an extra copy operation in order to convert the raw data-type to bytes.

If possible, implementations should override the typed put operations with a more efficient implementation that can write the data type directly. Usually, it is sufficient to override the operations that take an array as well as an offset and length, because those methods a called by the convenience methods that take a single value or an array without additional parameters. However, derived classes are also free to override the other methods, if they can provide a more efficient implementation for them.

Author:

Sebastian Marsching

Nested Class Summary

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

ByteSink.AtomicPutOperation<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	AbstractByteSink() Default constructor.

Method Summary

Modifier and Type	Method and Description
ByteSink	putByte(byte b) Writes a single byte to this byte sink.
ByteSink	putByteArray(byte[] source) Writes a complete array of bytes to this byte sink.
ByteSink	putDouble(double value) Writes a single double value to this byte sink.
ByteSink	putDoubleArray(double[] source) Writes a complete array of double values to this byte sink.
ByteSink	putDoubleArray(double[] source, int offset, int length) Writes a slice of an array of double values to this byte sink.
ByteSink	putFloat(float value) Writes a single float value to this byte sink.
ByteSink	putFloatArray(float[] source) Writes a complete array of float values to this byte sink.
ByteSink	putFloatArray(float[] source, int offset, int length) Writes a slice of an array of float values to this byte sink.
ByteSink	putInt(int value) Writes a single int value to this byte sink.
ByteSink	putIntArray(int[] source) Writes a complete array of int values to this byte sink.
ByteSink	putIntArray(int[] source, int offset, int length) Writes a slice of an array of int values to this byte sink.
ByteSink	putLong(long value) Writes a single long value to this byte sink.
ByteSink	putLongArray(long[] source) Writes a complete array of long values to this byte sink.
ByteSink	putLongArray(long[] source, int offset, int length) Writes a slice of an array of long values to this byte sink.
ByteSink	putShort(short value) Writes a single short value to this byte sink.
ByteSink	putShortArray(short[] source) Writes a complete array of short values to this byte sink.
ByteSink	putShortArray(short[] source, int offset, int length) Writes a slice of an array of short values to this byte sink.

Methods inherited from class java.lang.Object

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

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

atomicPut, putByteArray

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

AbstractByteSink

protected AbstractByteSink()

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

Method Detail

putByte

public ByteSink putByte(byte b)

Description copied from interface: ByteSink

Writes a single byte to this byte sink.

Specified by:

putByte in interface ByteSink

Parameters:

b - byte to be written.

Returns:

reference to this byte sink.

putByteArray

public ByteSink putByteArray(byte[] source)

Description copied from interface: ByteSink

Writes a complete array of bytes to this byte sink.

Specified by:

putByteArray in interface ByteSink

Parameters:

source - array of bytes that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putDouble

public ByteSink putDouble(double value)

Description copied from interface: ByteSink

Writes a single double value to this byte sink.

Specified by:

putDouble in interface ByteSink

Parameters:

value - value to be written.

Returns:

reference to this byte sink.

putDoubleArray

public ByteSink putDoubleArray(double[] source)

Description copied from interface: ByteSink

Writes a complete array of double values to this byte sink.

Specified by:

putDoubleArray in interface ByteSink

Parameters:

source - array of double values that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putDoubleArray

public ByteSink putDoubleArray(double[] source,
                               int offset,
                               int length)

Description copied from interface: ByteSink

Writes a slice of an array of double values to this byte sink.

Specified by:

putDoubleArray in interface ByteSink

Parameters:

source - array of double values that should be partially written to this byte sink.

offset - offset into source. Data will be read from the array starting at this index.

length - number of values to be written.

Returns:

reference to this byte sink.

putFloat

public ByteSink putFloat(float value)

Description copied from interface: ByteSink

Writes a single float value to this byte sink.

Specified by:

putFloat in interface ByteSink

Parameters:

value - value to be written.

Returns:

reference to this byte sink.

putFloatArray

public ByteSink putFloatArray(float[] source)

Description copied from interface: ByteSink

Writes a complete array of float values to this byte sink.

Specified by:

putFloatArray in interface ByteSink

Parameters:

source - array of float values that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putFloatArray

public ByteSink putFloatArray(float[] source,
                              int offset,
                              int length)

Description copied from interface: ByteSink

Writes a slice of an array of float values to this byte sink.

Specified by:

putFloatArray in interface ByteSink

Parameters:

source - array of float values that should be partially written to this byte sink.

offset - offset into source. Data will be read from the array starting at this index.

length - number of values to be written.

Returns:

reference to this byte sink.

putInt

public ByteSink putInt(int value)

Description copied from interface: ByteSink

Writes a single int value to this byte sink.

Specified by:

putInt in interface ByteSink

Parameters:

value - value to be written.

Returns:

reference to this byte sink.

putIntArray

public ByteSink putIntArray(int[] source)

Description copied from interface: ByteSink

Writes a complete array of int values to this byte sink.

Specified by:

putIntArray in interface ByteSink

Parameters:

source - array of int values that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putIntArray

public ByteSink putIntArray(int[] source,
                            int offset,
                            int length)

Description copied from interface: ByteSink

Writes a slice of an array of int values to this byte sink.

Specified by:

putIntArray in interface ByteSink

Parameters:

source - array of int values that should be partially written to this byte sink.

offset - offset into source. Data will be read from the array starting at this index.

length - number of values to be written.

Returns:

reference to this byte sink.

putShort

public ByteSink putShort(short value)

Description copied from interface: ByteSink

Writes a single short value to this byte sink.

Specified by:

putShort in interface ByteSink

Parameters:

value - value to be written.

Returns:

reference to this byte sink.

putShortArray

public ByteSink putShortArray(short[] source)

Description copied from interface: ByteSink

Writes a complete array of short values to this byte sink.

Specified by:

putShortArray in interface ByteSink

Parameters:

source - array of short values that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putShortArray

public ByteSink putShortArray(short[] source,
                              int offset,
                              int length)

Description copied from interface: ByteSink

Writes a slice of an array of short values to this byte sink.

Specified by:

putShortArray in interface ByteSink

Parameters:

source - array of short values that should be partially written to this byte sink.

offset - offset into source. Data will be read from the array starting at this index.

length - number of values to be written.

Returns:

reference to this byte sink.

putLong

public ByteSink putLong(long value)

Description copied from interface: ByteSink

Writes a single long value to this byte sink.

Specified by:

putLong in interface ByteSink

Parameters:

value - value to be written.

Returns:

reference to this byte sink.

putLongArray

public ByteSink putLongArray(long[] source)

Description copied from interface: ByteSink

Writes a complete array of long values to this byte sink.

Specified by:

putLongArray in interface ByteSink

Parameters:

source - array of long values that should be completely written to this byte sink.

Returns:

reference to this byte sink.

putLongArray

public ByteSink putLongArray(long[] source,
                             int offset,
                             int length)

Description copied from interface: ByteSink

Writes a slice of an array of long values to this byte sink.

Specified by:

putLongArray in interface ByteSink

Parameters:

source - array of long values that should be partially written to this byte sink.

offset - offset into source. Data will be read from the array starting at this index.

length - number of values to be written.

Returns:

reference to this byte sink.