Module com.darkcollective.relix.lang.ast
Package com.darkcollective.relix.lang.ast.source

Record Class CsvExtractSpec

java.lang.Object
java.lang.Record
com.darkcollective.relix.lang.ast.source.CsvExtractSpec
Record Components:
hasHeader - true if the first row of the CSV contains column names (which are matched against the schema's column names); false if columns are matched positionally
All Implemented Interfaces:
ExtractSpec
public record CsvExtractSpec(boolean hasHeader) extends Record implements ExtractSpec
Extracts tabular data from a CSV response body.

Syntax: extract: csv(header: true)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final CsvExtractSpec
    WITH_HEADER
    Convenience constant: CSV with a header row (the common case).
    static final CsvExtractSpec
    WITHOUT_HEADER
    Convenience constant: CSV without a header row (positional matching).

  • Constructor Summary

    Constructors
    Constructor
    Description
    CsvExtractSpec(boolean hasHeader)
    Creates an instance of a CsvExtractSpec 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.
    boolean
    hasHeader()
    Returns the value of the hasHeader record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • WITH_HEADER

      public static final CsvExtractSpec WITH_HEADER
      Convenience constant: CSV with a header row (the common case).

    • WITHOUT_HEADER

      public static final CsvExtractSpec WITHOUT_HEADER
      Convenience constant: CSV without a header row (positional matching).

  • Constructor Details

    • CsvExtractSpec

      public CsvExtractSpec(boolean hasHeader)
      Creates an instance of a CsvExtractSpec record class.
      Parameters:
      hasHeader - the value for the hasHeader 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 '=='.
      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.

    • hasHeader

      public boolean hasHeader()
      Returns the value of the hasHeader record component.
      Returns:
      the value of the hasHeader record component