Package org.opendaylight.raft.api

Record Class TermInfo

java.lang.Object
java.lang.Record
org.opendaylight.raft.api.TermInfo
Record Components:
term - election term
votedFor - the member we have voted for, null if we have not voted for anyone
@NonNullByDefault public record TermInfo(long term, @Nullable String votedFor) extends Record
Information about a RAFT term. Includes the term itself and information whether we voted for a member or not.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TermInfo
    INITIAL
    Initial {#link TermInfo}.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TermInfo(long term)
    Convenience shorthand for new TermInfo(term, null).
    TermInfo(long term, @Nullable String votedFor)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    term()
    Returns the value of the term record component.
    String
    toString()
    Returns a string representation of this record class.
    @Nullable String
    votedFor()
    Returns the value of the votedFor record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • INITIAL

      public static final TermInfo INITIAL
      Initial {#link TermInfo}. Equivalent to new TermInfo(0), e.g. we know there is a first term and we have not voted in it, as far as we can remember.

  • Constructor Details

    • TermInfo

      public TermInfo(long term, @Nullable String votedFor)
      Default constructor.
      Parameters:
      term - election term
      votedFor - the member we have voted for, null if we have not voted for anyone

    • TermInfo

      public TermInfo(long term)
      Convenience shorthand for new TermInfo(term, null).
      Parameters:
      term - tbe term

  • Method Details

    • toString

      public 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • term

      public long term()
      Returns the value of the term record component.
      Returns:
      the value of the term record component

    • votedFor

      public @Nullable String votedFor()
      Returns the value of the votedFor record component.
      Returns:
      the value of the votedFor record component