Module swim.codec
Package swim.codec

Class InputSettings

java.lang.Object
swim.codec.InputSettings
All Implemented Interfaces:
Debug
public class InputSettings extends Object implements Debug
Input consumption parameters. InputSettings provide contextual configuration parameters to input consumers, such as Parsers.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final boolean
    isStripped
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    InputSettings(boolean isStripped)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    protected InputSettings
    copy(boolean isStripped)
     
    static final InputSettings
    create(boolean isStripped)
    Returns InputSettings configured to not include diagnostic metadata in generated output, if isStripped is true.
    <T> Output<T>
    debug(Output<T> output)
    Writes a developer readable, debug-formatted string representation of this object to output.
    boolean
    equals(Object other)
     
    int
    hashCode()
     
    final boolean
    isStripped()
    Returns true if input consumers should not include diagnostic metadata in generated output.
    InputSettings
    isStripped(boolean isStripped)
    Returns a copy of these settings with the given isStripped flag.
    static final InputSettings
    standard()
    Returns InputSettings configured to include diagnostic metadata in generated output.
    static final InputSettings
    stripped()
    Returns InputSettings configured to not include diagnostic metadata in generated output.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • isStripped

      protected final boolean isStripped

  • Constructor Details

    • InputSettings

      protected InputSettings(boolean isStripped)

  • Method Details

    • isStripped

      public final boolean isStripped()
      Returns true if input consumers should not include diagnostic metadata in generated output.

    • isStripped

      public InputSettings isStripped(boolean isStripped)
      Returns a copy of these settings with the given isStripped flag.

    • copy

      protected InputSettings copy(boolean isStripped)

    • canEqual

      protected boolean canEqual(Object other)

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • debug

      public <T> Output<T> debug(Output<T> output)
      Description copied from interface: Debug
      Writes a developer readable, debug-formatted string representation of this object to output.
      Specified by:
      debug in interface Debug
      Returns:
      the continuation of the output.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • standard

      public static final InputSettings standard()
      Returns InputSettings configured to include diagnostic metadata in generated output.

    • stripped

      public static final InputSettings stripped()
      Returns InputSettings configured to not include diagnostic metadata in generated output.

    • create

      public static final InputSettings create(boolean isStripped)
      Returns InputSettings configured to not include diagnostic metadata in generated output, if isStripped is true.