Package io.keikai.doc.collab.structs

Class GC

java.lang.Object

io.keikai.doc.collab.structs.AbstractStruct

io.keikai.doc.collab.structs.GC

public class GC
extends AbstractStruct

Field Summary

Fields

Modifier and Type	Field	Description
static int	STRUCT_GC_REF_NUMBER

Constructor Summary

Constructors

Constructor	Description
GC(ID id, int length)

Method Summary

Modifier and Type	Method	Description
void	delete()
java.lang.Integer	getMissing(Transaction transaction, StructStore store)	Since GC structs are always considered deleted, they don't have missing parts.
void	integrate(Transaction transaction, int offset)	Integrate this struct into a transaction.
boolean	isDeleted()
boolean	mergeWith(AbstractStruct right)	Merge this struct with the item to the right.
void	write(UpdateEncoder encoder, int offset)	Write data to the encoder.

Methods inherited from class io.keikai.doc.collab.structs.AbstractStruct

getId, length, setLength, write

Methods inherited from class java.lang.Object

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

Field Detail

STRUCT_GC_REF_NUMBER

public static final int STRUCT_GC_REF_NUMBER

See Also:

Constant Field Values

Constructor Detail

GC

public GC(ID id,
          int length)

Method Detail

isDeleted

public boolean isDeleted()

Overrides:

isDeleted in class AbstractStruct

Returns:

boolean indicating if this struct is deleted

delete

public void delete()

mergeWith

public boolean mergeWith(AbstractStruct right)

Description copied from class: AbstractStruct

Merge this struct with the item to the right. This method assumes that `this.id.clock + this.length === right.id.clock`. Also, this method does *not* remove the right struct from the StructStore!

Overrides:

mergeWith in class AbstractStruct

Parameters:

right -

Returns:

boolean indicating whether the merge was successful.

integrate

public void integrate(Transaction transaction,
                      int offset)

Description copied from class: AbstractStruct

Integrate this struct into a transaction.

Overrides:

integrate in class AbstractStruct

Parameters:

transaction - The transaction object.

offset - The offset value.

write

public void write(UpdateEncoder encoder,
                  int offset)

Description copied from class: AbstractStruct

Write data to the encoder.

Overrides:

write in class AbstractStruct

Parameters:

encoder - The UpdateEncoderV1 encoder.

offset - The offset value.

getMissing

public java.lang.Integer getMissing(Transaction transaction,
                                    StructStore store)

Since GC structs are always considered deleted, they don't have missing parts.

Parameters:

transaction - The transaction object.

store - The struct store.

Returns:

null since there's no missing client ID.