Package io.keikai.doc.collab.utils

Class UpdateDecoderV2

java.lang.Object

io.keikai.doc.collab.utils.DSDecoderV2

io.keikai.doc.collab.utils.UpdateDecoderV2

All Implemented Interfaces:

DSDecoder, UpdateDecoder

public class UpdateDecoderV2
extends DSDecoderV2
implements UpdateDecoder

Field Summary

Fields inherited from class io.keikai.doc.collab.utils.DSDecoderV2

_restDecoder

Constructor Summary

Constructors

Constructor	Description
UpdateDecoderV2(Decoder decoder)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	readAny()
Uint8Array	readBuf()
int	readClient()	Read the next client ID.
int	readInfo()
java.lang.Object	readJSON()	This is mainly here for legacy purposes.
java.lang.String	readKey()
ID	readLeftID()
int	readLen()	Write len of a struct - well suited for Opt RLE encoder.
boolean	readParentInfo()
ID	readRightID()
java.lang.String	readString()
int	readTypeRef()

Methods inherited from class io.keikai.doc.collab.utils.DSDecoderV2

getRestDecoder, readDsClock, readDsLen, resetDsCurVal

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.keikai.doc.collab.utils.DSDecoder

getRestDecoder, readDsClock, readDsLen, resetDsCurVal

Constructor Detail

UpdateDecoderV2

public UpdateDecoderV2(Decoder decoder)

Method Detail

readLeftID

public ID readLeftID()

Specified by:

readLeftID in interface UpdateDecoder

Returns:

ID with the left client ID and clock

readRightID

public ID readRightID()

Specified by:

readRightID in interface UpdateDecoder

Returns:

ID with the right client ID and clock

readClient

public int readClient()

Read the next client ID. Use this in favor of readID whenever possible to reduce the number of objects created.

Specified by:

readClient in interface UpdateDecoder

readInfo

public int readInfo()

Specified by:

readInfo in interface UpdateDecoder

Returns:

info An unsigned 8-bit integer

readString

public java.lang.String readString()

Specified by:

readString in interface UpdateDecoder

Returns:

the next string

readParentInfo

public boolean readParentInfo()

Specified by:

readParentInfo in interface UpdateDecoder

Returns:

parent info as a boolean

readTypeRef

public int readTypeRef()

Specified by:

readTypeRef in interface UpdateDecoder

Returns:

Type reference as an unsigned 8-bit integer

readLen

public int readLen()

Description copied from interface: UpdateDecoder

Write len of a struct - well suited for Opt RLE encoder.

Specified by:

readLen in interface UpdateDecoder

Returns:

length of a struct, well suited for Opt RLE decoder

readAny

public java.lang.Object readAny()

Specified by:

readAny in interface UpdateDecoder

Returns:

the next "any" value

readBuf

public Uint8Array readBuf()

Specified by:

readBuf in interface UpdateDecoder

Returns:

the next byte array

readJSON

public java.lang.Object readJSON()

This is mainly here for legacy purposes. Initially, we encoded objects using JSON. Now we use the much faster lib0/any-encoder. This method mainly exists for legacy purposes for the v1 encoder.

Specified by:

readJSON in interface UpdateDecoder

Returns:

the next JSON object

readKey

public java.lang.String readKey()

Specified by:

readKey in interface UpdateDecoder

Returns:

the next key string