BinaryCifCodec (ciftools-java 2.0.1 API)

java.lang.Object

org.rcsb.cif.binary.codec.BinaryCifCodec

public class BinaryCifCodec
extends Object

A library of codec implementations and provider to codec-specific constants such as encoder name, version, and minimal version of the data to decode.

Field Summary

Fields

Modifier and Type Field Description

static String CODEC_NAME

static boolean IS_NATIVE_LITTLE_ENDIAN

static String MIN_VERSION

static String VERSION
Constructor Summary

Constructors

Constructor Description

BinaryCifCodec()

Method Summary

Modifier and Type	Method	Description
`static Object`	`decode(Map<String,Object> encodedData)`	Decode an instance of `EncodedData` by traversing its encoding chain until the original data is restored.
`static EncodedData<?>`	`decode(EncodedData<?> data)`	Request decoding of this `EncodedData` instance.

Methods inherited from class java.lang.Object

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

Field Details
- CODEC_NAME
  
  public static final String CODEC_NAME
  
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final String VERSION
  
  See Also:
  
  Constant Field Values
- MIN_VERSION
  
  public static final String MIN_VERSION
  
  See Also:
  
  Constant Field Values
- IS_NATIVE_LITTLE_ENDIAN
  
  public static final boolean IS_NATIVE_LITTLE_ENDIAN
Constructor Details
- BinaryCifCodec
  
  public BinaryCifCodec()
Method Details
- decode
  
  public static EncodedData<?> decode(EncodedData<?> data)
  
  Request decoding of this EncodedData instance. Will automatically resolve its decoding chain, starting from a ByteArray until 'raw' data represented by Int32Array, Float64Array, or StringArray classes is achieved which is then ready to use.
  
  Parameters:
  
  data - what to decode
  
  Returns:
  
  the decoded data
- decode
  
  public static Object decode(Map<String,Object> encodedData)
  
  Decode an instance of EncodedData by traversing its encoding chain until the original data is restored.
  
  Parameters:
  
  encodedData - the map of data to decode
  
  Returns:
  
  the decoded data