Record Class StringAggParams

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.StringAggParams
All Implemented Interfaces:
AggregateParams

public record StringAggParams(String delimiter) extends Record implements AggregateParams
Delimiter parameter of STRING_AGG and STRING_DISTINCT_AGG. The delimiter must not be null; engines insert it into SQL as a string literal and are responsible for escaping it.

Thread-safe: immutable record.

  • Constructor Details

    • StringAggParams

      public StringAggParams(String delimiter)
      Creates an instance of a StringAggParams record class.
      Parameters:
      delimiter - the value for the delimiter record component
  • Method Details

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

      public String delimiter()
      Returns the value of the delimiter record component.
      Returns:
      the value of the delimiter record component