Package io.camunda.zeebe.journal.record

Record Class PersistedJournalRecord

java.lang.Object
java.lang.Record
io.camunda.zeebe.journal.record.PersistedJournalRecord
All Implemented Interfaces:
JournalRecord
public record PersistedJournalRecord(RecordMetadata metadata, RecordData record) extends Record implements JournalRecord
A JournalRecord stored in a buffer.

A PersistedJournalRecord consists of two parts. The first part is RecordMetadata. The second part is RecordData.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PersistedJournalRecord(RecordMetadata metadata, RecordData record)
    Creates an instance of a PersistedJournalRecord record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    asqn()
    Application sequence number for the record
    long
    checksum()
    Checksum of the data
    org.agrona.DirectBuffer
    data()
    Application provided data of the record
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    index()
    Index of the record
    RecordMetadata
    metadata()
    Returns the value of the metadata record component.
    RecordData
    record()
    Returns the value of the record record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PersistedJournalRecord

      public PersistedJournalRecord(RecordMetadata metadata, RecordData record)
      Creates an instance of a PersistedJournalRecord record class.
      Parameters:
      metadata - the value for the metadata record component
      record - the value for the record record component

  • Method Details

    • index

      public long index()
      Description copied from interface: JournalRecord
      Index of the record
      Specified by:
      index in interface JournalRecord
      Returns:
      index

    • asqn

      public long asqn()
      Description copied from interface: JournalRecord
      Application sequence number for the record
      Specified by:
      asqn in interface JournalRecord
      Returns:
      asqn

    • checksum

      public long checksum()
      Description copied from interface: JournalRecord
      Checksum of the data
      Specified by:
      checksum in interface JournalRecord
      Returns:
      checksum

    • data

      public org.agrona.DirectBuffer data()
      Description copied from interface: JournalRecord
      Application provided data of the record
      Specified by:
      data in interface JournalRecord
      Returns:
      data

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • metadata

      public RecordMetadata metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component

    • record

      public RecordData record()
      Returns the value of the record record component.
      Returns:
      the value of the record record component