Record Class StorageResult.SuccessResult<T>

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.data.StorageResult.SuccessResult<T>
Type Parameters:
T - the data type.
Record Components:
qualityCode - the quality of the operation.
successfulData - the data that was stored.
unchangedData - the subset of successfulData the engine already held and did not write.
All Implemented Interfaces:
StorageResult<T>
Enclosing interface:
StorageResult<T>

public static record StorageResult.SuccessResult<T>(QualityCode qualityCode, List<T> successfulData, List<T> unchangedData) extends Record implements StorageResult<T>
All data was stored.
  • Constructor Details

    • SuccessResult

      public SuccessResult(QualityCode qualityCode, List<T> successfulData, List<T> unchangedData)
      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
      unchangedData - the value for the unchangedData record component
    • SuccessResult

      public SuccessResult(QualityCode qualityCode, List<T> successfulData)
  • Method Details

    • failedData

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

      public Optional<Exception> error()
      Description copied from interface: StorageResult
      Returns the exception from the storage operation, if any.
      Specified by:
      error in interface StorageResult<T>
      Returns:
      the exception, or empty.
    • type

      public StorageResult.Type type()
      Description copied from interface: StorageResult
      Returns the kind of result.
      Specified by:
      type in interface StorageResult<T>
      Returns:
      the result 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
    • unchangedData

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