Package com.inductiveautomation.historian.gateway.api.storage.realtime

Record Class CollectionSnapshot

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionSnapshot
public record CollectionSnapshot(CollectedPoints collectedPoints, @Nullable CollectionContext collectionContext) extends Record

  • Constructor Details

    • CollectionSnapshot

      public CollectionSnapshot(CollectedPoints collectedPoints, @Nullable @Nullable CollectionContext collectionContext)
      Creates an instance of a CollectionSnapshot record class.
      Parameters:
      collectedPoints - the value for the collectedPoints record component
      collectionContext - the value for the collectionContext record component

  • Method Details

    • of

      public static CollectionSnapshot of(CollectedPoints collectedPoints, CollectionContext collectionContext)

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

    • collectedPoints

      public CollectedPoints collectedPoints()
      Returns the value of the collectedPoints record component.
      Returns:
      the value of the collectedPoints record component

    • collectionContext

      @Nullable public @Nullable CollectionContext collectionContext()
      Returns the value of the collectionContext record component.
      Returns:
      the value of the collectionContext record component