Package org.rcsb.cif.binary.encoding

Class ByteArrayEncoding<T extends NumberArray<?>>

java.lang.Object

org.rcsb.cif.binary.encoding.ByteArrayEncoding<T>

All Implemented Interfaces:

Encoding<T,ByteArray>

public abstract class ByteArrayEncoding<T extends NumberArray<?>>
extends Object
implements Encoding<T,ByteArray>

Encodes an array of numbers of specified types as raw bytes. E.g. values in the range from 0...255 (i.e. an Uint8Array) can be efficiently represented by single byte rather than int values which would require four bytes.

 ByteArray {
     kind = "ByteArray"
     type: Int8Array | Int16Array | Int32Array | Uint8Array | Uint16Array | Uint32Array | Float32Array | Float64Array
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static ByteArrayEncoding<Float32Array>	FLOAT32
static ByteArrayEncoding<Float64Array>	FLOAT64
static ByteArrayEncoding<Int16Array>	INT16
static ByteArrayEncoding<Int32Array>	INT32
static ByteArrayEncoding<Int8Array>	INT8
static ByteArrayEncoding<Uint16Array>	UINT16
static ByteArrayEncoding<Uint32Array>	UINT32
static ByteArrayEncoding<Uint8Array>	UINT8

Method Summary

Modifier and Type	Method	Description
ByteArray	encode(T data)	Move one step down the encoding deque.
Map<String,Object>	getMapRepresentation()	Converts this encoding to its map representation that can be serialized as BinaryCif.
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.encoding.Encoding

decode

Field Details

INT8

public static final ByteArrayEncoding<Int8Array> INT8

INT16

public static final ByteArrayEncoding<Int16Array> INT16

INT32

public static final ByteArrayEncoding<Int32Array> INT32

UINT8

public static final ByteArrayEncoding<Uint8Array> UINT8

UINT16

public static final ByteArrayEncoding<Uint16Array> UINT16

UINT32

public static final ByteArrayEncoding<Uint32Array> UINT32

FLOAT32

public static final ByteArrayEncoding<Float32Array> FLOAT32

FLOAT64

public static final ByteArrayEncoding<Float64Array> FLOAT64

Method Details

encode

public ByteArray encode(T data)

Description copied from interface: Encoding

Move one step down the encoding deque. One step closer to a ByteArray representation.

Specified by:

encode in interface Encoding<T extends NumberArray<?>,ByteArray>

Parameters:

data - the container to encode

Returns:

the decoded information

getMapRepresentation

public Map<String,Object> getMapRepresentation()

Description copied from interface: Encoding

Converts this encoding to its map representation that can be serialized as BinaryCif.

Specified by:

getMapRepresentation in interface Encoding<T extends NumberArray<?>,ByteArray>

Returns:

a Map that contains all encoding information

toString

public String toString()

Overrides:

toString in class Object