Record Class WindowId

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.query.pipeline.WindowId

public record WindowId(long startMs, long endMs) extends Record
Identifier for a closed time window: [startMs, endMs).
  • Constructor Summary

    Constructors
    Constructor
    Description
    WindowId(long startMs, long endMs)
    Creates an instance of a WindowId record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    Returns the value of the endMs record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    long
     
    long
    Returns the value of the startMs record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • WindowId

      public WindowId(long startMs, long endMs)
      Creates an instance of a WindowId record class.
      Parameters:
      startMs - the value for the startMs record component
      endMs - the value for the endMs record component
  • Method Details

    • sizeMs

      public long sizeMs()
    • 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 the compare method from their corresponding wrapper classes.
      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.
    • startMs

      public long startMs()
      Returns the value of the startMs record component.
      Returns:
      the value of the startMs record component
    • endMs

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