Package com.inductiveautomation.historian.common.model.data

Record Class StorageResult.SuccessResult<T>

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.data.StorageResult.SuccessResult<T>
Type Parameters:
T - The type of data that was stored
Record Components:
qualityCode - The QualityCode indicating the success of the operation
successfulData - The List of successfully stored T
All Implemented Interfaces:
StorageResult<T>
Enclosing interface:
StorageResult<T>
public static record StorageResult.SuccessResult<T>(QualityCode qualityCode, List<T> successfulData) extends Record implements StorageResult<T>
Represents a fully successful storage operation where all data were stored successfully.

  • Constructor Details

    • SuccessResult

      public SuccessResult(QualityCode qualityCode, List<T> successfulData)
      Creates an instance of a SuccessResult record class.
      Parameters:
      qualityCode - the value for the qualityCode record component
      successfulData - the value for the successfulData record component

  • Method Details

    • failedData

      public List<T> failedData()
      Description copied from interface: StorageResult
      Returns the list of data that failed to be stored.
      Specified by:
      failedData in interface StorageResult<T>
      Returns:
      an unmodifiable List of T that failed to be stored

    • error

      public Optional<Exception> error()
      Description copied from interface: StorageResult
      Returns an Optional containing the exception if one occurred during the storage operation.
      Specified by:
      error in interface StorageResult<T>
      Returns:
      an Optional of Exception, empty if no exception occurred

    • type

      public StorageResult.Type type()
      Description copied from interface: StorageResult
      Returns the exact type that this storage result represents.
      Specified by:
      type in interface StorageResult<T>
      Returns:
      the result StorageResult.Type

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

    • qualityCode

      public QualityCode qualityCode()
      Returns the value of the qualityCode record component.
      Specified by:
      qualityCode in interface StorageResult<T>
      Returns:
      the value of the qualityCode record component

    • successfulData

      public List<T> successfulData()
      Returns the value of the successfulData record component.
      Specified by:
      successfulData in interface StorageResult<T>
      Returns:
      the value of the successfulData record component