Package com.inductiveautomation.ignition.gateway.storeforward.stores.info

Record Class DataSummary

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.storeforward.stores.info.DataSummary
public record DataSummary(int totalCount, long oldestTimestamp, long recentTimestamp, int maximum) extends Record
A record representing a snapshot of the data contained within a store.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    DataSummary.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataSummary(int totalCount, int maximum)
    Constructs a new DataSummary with the specified total count and maximum allowed.
    DataSummary(int totalCount, long oldestTimestamp, long recentTimestamp)
    Constructs a new DataSummary with the specified total count, oldest timestamp, and recent timestamp.
    DataSummary(int totalCount, long oldestTimestamp, long recentTimestamp, int maximum)
    Creates an instance of a DataSummary 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.
    int
    maximum()
    Returns the value of the maximum record component.
    static DataSummary.Builder
    newBuilder()
     
    static DataSummary.Builder
    newBuilder(DataSummary dataSummary)
     
    long
    oldestTimestamp()
    Returns the value of the oldestTimestamp record component.
    long
    recentTimestamp()
    Returns the value of the recentTimestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalCount()
    Returns the value of the totalCount record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataSummary

      public DataSummary(int totalCount, long oldestTimestamp, long recentTimestamp)
      Constructs a new DataSummary with the specified total count, oldest timestamp, and recent timestamp.
      Parameters:
      totalCount - The total number of data in the store.
      oldestTimestamp - The timestamp of the oldest data in the collection.
      recentTimestamp - The timestamp of the most recent data in the collection.

    • DataSummary

      public DataSummary(int totalCount, int maximum)
      Constructs a new DataSummary with the specified total count and maximum allowed.
      Parameters:
      totalCount - The total number of data in the store.
      maximum - The maximum allowed data within the store.

    • DataSummary

      public DataSummary(int totalCount, long oldestTimestamp, long recentTimestamp, int maximum)
      Creates an instance of a DataSummary record class.
      Parameters:
      totalCount - the value for the totalCount record component
      oldestTimestamp - the value for the oldestTimestamp record component
      recentTimestamp - the value for the recentTimestamp record component
      maximum - the value for the maximum record component

  • Method Details

    • newBuilder

      public static DataSummary.Builder newBuilder()

    • newBuilder

      public static DataSummary.Builder newBuilder(DataSummary dataSummary)

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

    • totalCount

      public int totalCount()
      Returns the value of the totalCount record component.
      Returns:
      the value of the totalCount record component

    • oldestTimestamp

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

    • recentTimestamp

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

    • maximum

      public int maximum()
      Returns the value of the maximum record component.
      Returns:
      the value of the maximum record component