Package org.rcsb.cif.binary.data

Class Uint16Array

java.lang.Object

org.rcsb.cif.binary.data.Uint16Array

All Implemented Interfaces:

EncodedData<int[]>, IntArray, NumberArray<int[]>, UnsignedIntArray

public class Uint16Array
extends Object
implements UnsignedIntArray

An array of unsigned integer numbers using 16 bit to store each value.

Constructor Summary

Constructors

Constructor	Description
Uint16Array(int[] data)
Uint16Array(int[] data, Deque<Encoding<?,?>> encoding)
Uint16Array(ByteArray array)

Method Summary

Modifier and Type	Method	Description
ByteArray	encode()	Encode this array of numbers directly as binary data (useful for single values that won't benefit from more elaborate encoding chains).
int[]	getData()	Access to the underlying array of information.
Deque<Encoding<?,?>>	getEncoding()	All encodings registered for this piece of EncodedData.
int	getNumberOfBytes()	The number of bytes used in this representation to describe a single value (e.g.
int	getType()	Report the type of this number array.
boolean	hasNextDecodingStep()	Convenience method to state whether the List returned by EncodedData.getEncoding() is not empty.
int	length()	The number of elements in the wrapped array.
void	setEncoding(Deque<Encoding<?,?>> encoding)	Replace this encoding chain with a different one.
byte[]	toByteArray()	Converts this number array to its binary representation.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rcsb.cif.binary.data.EncodedData

decode, getEncoding, hasNextDecodingStep, setEncoding

Methods inherited from interface org.rcsb.cif.binary.data.IntArray

decode, encode

Methods inherited from interface org.rcsb.cif.binary.data.UnsignedIntArray

isSigned

Constructor Details

Uint16Array

public Uint16Array(int[] data)

Uint16Array

public Uint16Array(int[] data, Deque<Encoding<?,?>> encoding)

Uint16Array

public Uint16Array(ByteArray array)

Method Details

getData

public int[] getData()

Description copied from interface: EncodedData

Access to the underlying array of information.

Specified by:

getData in interface EncodedData<int[]>

Specified by:

getData in interface IntArray

Returns:

an int[], double[], byte[], or String[]

length

public int length()

Description copied from interface: EncodedData

The number of elements in the wrapped array.

Specified by:

length in interface EncodedData<int[]>

Specified by:

length in interface IntArray

Returns:

results of array.length

toByteArray

public byte[] toByteArray()

Description copied from interface: NumberArray

Converts this number array to its binary representation.

Specified by:

toByteArray in interface NumberArray<int[]>

Returns:

a byte[]

getNumberOfBytes

public int getNumberOfBytes()

Description copied from interface: NumberArray

The number of bytes used in this representation to describe a single value (e.g. 1 for Int8Array and up to 8 for Float64Array).

Specified by:

getNumberOfBytes in interface NumberArray<int[]>

Returns:

a number between 1 and 4

getType

public int getType()

Description copied from interface: NumberArray

Report the type of this number array.

• 1 for Int8Array
• 2 for Int16Array
• 3 for Int32Array
• 4 for Uint8Array
• 5 for Uint16Array
• 6 for Uint32Array
• 32 for Float32Array
• 33 for Float64Array

Specified by:

getType in interface NumberArray<int[]>

Returns:

1, 2, 3, 4, 5, 6, 32, 33

encode

public ByteArray encode()

Description copied from interface: NumberArray

Encode this array of numbers directly as binary data (useful for single values that won't benefit from more elaborate encoding chains).

Specified by:

encode in interface NumberArray<int[]>

Returns:

a ByteArray with a single encoding step

toString

public String toString()

Overrides:

toString in class Object

getEncoding

public Deque<Encoding<?,?>> getEncoding()

Description copied from interface: EncodedData

All encodings registered for this piece of EncodedData. May be empty. May contain only partial data: e.g. adding a ByteArrayEncoding to the list will request encoding by ByteArrayCodec, this method call will subsequently fill all fields of the requested Encoding to allow for decoding.

Specified by:

getEncoding in interface EncodedData<D>

Returns:

all associated Encoding instances

setEncoding

public void setEncoding(Deque<Encoding<?,?>> encoding)

Description copied from interface: EncodedData

Replace this encoding chain with a different one.

Specified by:

setEncoding in interface EncodedData<D>

Parameters:

encoding - the new encoding chain for this instance

hasNextDecodingStep

public boolean hasNextDecodingStep()

Description copied from interface: EncodedData

Convenience method to state whether the List returned by EncodedData.getEncoding() is not empty.

Specified by:

hasNextDecodingStep in interface EncodedData<D>

Returns:

true if encoding steps are registered and need to be resolved to access decoded data