Package se.idkollen.client

Record Class PollOptions

java.lang.Object
java.lang.Record
se.idkollen.client.PollOptions
public record PollOptions(long intervalMs, long timeoutMs) extends Record
Options controlling the behaviour of the high-level waitFor* polling helpers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PollOptions()
    Create options with default values: 2 s interval, 300 s timeout.
    PollOptions(long intervalMs, long timeoutMs)
    Creates an instance of a PollOptions record class.

  • 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
    intervalMs()
    Returns the value of the intervalMs record component.
    long
    timeoutMs()
    Returns the value of the timeoutMs 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

    • PollOptions

      public PollOptions()
      Create options with default values: 2 s interval, 300 s timeout.

    • PollOptions

      public PollOptions(long intervalMs, long timeoutMs)
      Creates an instance of a PollOptions record class.
      Parameters:
      intervalMs - the value for the intervalMs record component
      timeoutMs - the value for the timeoutMs record component

  • Method Details

    • 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 '=='.
      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.

    • intervalMs

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

    • timeoutMs

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