Enum Class InputFormat

java.lang.Object
java.lang.Enum<InputFormat>
com.darkcollective.relix.embed.InputFormat
All Implemented Interfaces:
Serializable, Comparable<InputFormat>, Constable

public enum InputFormat extends Enum<InputFormat>
How the text of an Input is written.
Since:
1.0
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Comma-separated values with a header row naming the columns, read as a csv("…") source reads a file: RFC 4180 quoting, an empty field a NULL, a row that ends early refused.
    One JSON array of objects, each object a row.
    One JSON object per line — JSON lines, NDJSON — each a row.
    Tab-separated values with a header row.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    static InputFormat[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • CSV

      public static final InputFormat CSV
      Comma-separated values with a header row naming the columns, read as a csv("…") source reads a file: RFC 4180 quoting, an empty field a NULL, a row that ends early refused.
    • TSV

      public static final InputFormat TSV
      Tab-separated values with a header row. A field holds no tab or line break; a backslash escapes one (\t, \n, \r, \\).
    • JSON

      public static final InputFormat JSON
      One JSON array of objects, each object a row. Read whole, so it cannot stream.
    • NDJSON

      public static final InputFormat NDJSON
      One JSON object per line — JSON lines, NDJSON — each a row. The streaming form of JSON, and what jq -c writes.
  • Method Details

    • values

      public static InputFormat[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static InputFormat valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null