Record (Hazelcast Enterprise Hot Restart 3.12.12 API)

java.lang.Object
- com.hazelcast.spi.hotrestart.impl.gc.record.Record

Direct Known Subclasses:

RecordOffHeap, RecordOnHeap
```
public abstract class Record
extends Object
```
Holds the metadata on the newest record in a chunk associated with a given key and also some metadata on any dead records within the same chunk associated with the same key.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TOMB_HEADER_SIZE` Size of the tombstone record header in a chunk file: seq, prefix, key size
`static int`	`VAL_HEADER_SIZE` Size of the value record header in a chunk file: seq, prefix, key size, value size

Constructor Summary

Constructors
Constructor and Description

Record()

Constructors
Constructor and Description
`Record()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract int`	`additionalInt()`
`long`	`deadOrAliveSeq()`
`long`	`deadSeq()` Asserts that the record is dead and returns its sequence number.
`abstract int`	`decrementGarbageCount()` Decrements this record's garbage count.
`int`	`filePosition()` Asserts that this is a tombstone record and returns its offset in the underlying chunk file.
`int`	`garbageCount()`
`abstract void`	`incrementGarbageCount()` Increments this record's garbage count.
`boolean`	`isAlive()`
`boolean`	`isTombstone()`
`abstract long`	`keyPrefix(KeyHandle kh)`
`long`	`liveSeq()` Asserts that the record is alive and returns its sequence number.
`abstract void`	`negateSeq()` Negates the value of the `rawSeq` property.
`int`	`payloadSize()`
`static long`	`positionInUnitsOfBufsize(long filePosition)` Expresses the given file position in the unit of `HotRestarter.BUFFER_SIZE`.
`abstract long`	`rawSeqValue()`
`abstract int`	`rawSizeValue()`
`void`	`retire(boolean mayIncrementGarbageCount)` Retires this record (makes it dead).
`abstract void`	`setAdditionalInt(int value)` Sets the raw "additional int" property on this record.
`void`	`setFilePosition(int filePosition)` Asserts that this is a tombstone record and sets its offset in the underlying chunk file to the supplied value.
`void`	`setGarbageCount(int newCount)` Sets this record's garbage count to the given value.
`abstract void`	`setRawSeqSize(long rawSeqValue, int rawSizeValue)` Sets the raw "seq" and "size" values on this record.
`int`	`size()`
`static int`	`size(byte[] key, byte[] value)` Calculates the size in bytes a record would have in a chunk file if it contained the provided key and value blobs.
`static int`	`toRawSizeValue(int size, boolean isTombstone)` Encodes the given `size` and `isTombstone` parameters into a single `int` value of the raw "size" property.
`String`	`toString()`
`void`	`update(long seq, int size)` Updates the sequence number and size properties of this record to the supplied values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VAL_HEADER_SIZE
```
public static final int VAL_HEADER_SIZE
```
    Size of the value record header in a chunk file: seq, prefix, key size, value size
    
    See Also:
    
    Constant Field Values
  - TOMB_HEADER_SIZE
```
public static final int TOMB_HEADER_SIZE
```
    Size of the tombstone record header in a chunk file: seq, prefix, key size
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Record
```
public Record()
```
- Method Detail
  - deadOrAliveSeq
```
public final long deadOrAliveSeq()
```
    Returns:
    
    sequence number of this record, whether the record is alive or dead
  - liveSeq
```
public final long liveSeq()
```
    Asserts that the record is alive and returns its sequence number.
  - deadSeq
```
public final long deadSeq()
```
    Asserts that the record is dead and returns its sequence number.
  - size
```
public final int size()
```
    Returns:
    
    size in bytes of this record
  - payloadSize
```
public final int payloadSize()
```
    Returns:
    
    size in bytes of this record's payload (exluding the header)
  - isTombstone
```
public final boolean isTombstone()
```
  - isAlive
```
public boolean isAlive()
```
  - garbageCount
```
public final int garbageCount()
```
    Returns:
    
    the number of dead records with this record's key in this record's chunk.
  - filePosition
```
public final int filePosition()
```
    Asserts that this is a tombstone record and returns its offset in the underlying chunk file.
  - setFilePosition
```
public final void setFilePosition(int filePosition)
```
    Asserts that this is a tombstone record and sets its offset in the underlying chunk file to the supplied value.
  - update
```
public final void update(long seq,
                         int size)
```
    Updates the sequence number and size properties of this record to the supplied values.
  - retire
```
public final void retire(boolean mayIncrementGarbageCount)
```
    Retires this record (makes it dead).
    
    Parameters:
    
    mayIncrementGarbageCount - whether it is appropriate to increment the record's garbage count property (it is not appropriate to increment if the record is being retired due to a prefix tombstone)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - keyPrefix
```
public abstract long keyPrefix(KeyHandle kh)
```
    Parameters:
    
    kh - the key handle associated with this record
    
    Returns:
    
    the key prefix associated with this record
  - setRawSeqSize
```
public abstract void setRawSeqSize(long rawSeqValue,
                                   int rawSizeValue)
```
    Sets the raw "seq" and "size" values on this record.
    
    See Also:
    
    rawSeqValue(), rawSizeValue()
  - rawSeqValue
```
public abstract long rawSeqValue()
```
    Returns:
    
    the value of the raw, low-level "seq" property which encodes both the record's sequence number and whether it's alive. If zero, then this object does not relate to any live record, but garbageCount keeps tracking the number of garbage records on the same key in the same chunk.
  - rawSizeValue
```
public abstract int rawSizeValue()
```
    Returns:
    
    the raw, low-level "size" property which encodes both the size of the record and whether it's a tombstone.
  - setAdditionalInt
```
public abstract void setAdditionalInt(int value)
```
    Sets the raw "additional int" property on this record.
    
    See Also:
    
    additionalInt()
  - additionalInt
```
public abstract int additionalInt()
```
    Returns:
    
    the "additional int" property which, for a value record, denotes the garbage count and for a tombstone denotes file position.
  - negateSeq
```
public abstract void negateSeq()
```
    Negates the value of the rawSeq property.
  - decrementGarbageCount
```
public abstract int decrementGarbageCount()
```
    Decrements this record's garbage count.
  - incrementGarbageCount
```
public abstract void incrementGarbageCount()
```
    Increments this record's garbage count.
  - setGarbageCount
```
public final void setGarbageCount(int newCount)
```
    Sets this record's garbage count to the given value.
  - size
```
public static int size(byte[] key,
                       byte[] value)
```
    Calculates the size in bytes a record would have in a chunk file if it contained the provided key and value blobs.
    
    Parameters:
    
    key - the key blob
    
    value - the value blob (a null value signals a tombstone record)
  - toRawSizeValue
```
public static int toRawSizeValue(int size,
                                 boolean isTombstone)
```
    Encodes the given size and isTombstone parameters into a single int value of the raw "size" property.
  - positionInUnitsOfBufsize
```
public static long positionInUnitsOfBufsize(long filePosition)
```
    Expresses the given file position in the unit of HotRestarter.BUFFER_SIZE. Used during writing to a chunk file to determine when another buffer full of data was written out.

Class Record

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VAL_HEADER_SIZE

TOMB_HEADER_SIZE

Constructor Detail

Record

Method Detail

deadOrAliveSeq

liveSeq

deadSeq

size

payloadSize

isTombstone

isAlive

garbageCount

filePosition

setFilePosition

update

retire

toString

keyPrefix

setRawSeqSize

rawSeqValue

rawSizeValue

setAdditionalInt

additionalInt

negateSeq

decrementGarbageCount

incrementGarbageCount

setGarbageCount

size

toRawSizeValue

positionInUnitsOfBufsize