Module io.github.darvil.lanat
Package io.github.darvil.lanat.parsing.errors.contexts.formatting

Record Class DisplayInput

java.lang.Object
java.lang.Record
io.github.darvil.lanat.parsing.errors.contexts.formatting.DisplayInput
Record Components:
highlight - the highlight options to indicate the error formatter to highlight the input
public record DisplayInput(@Nullable DisplayInput.Highlight highlight) extends Record
Options used to display the input.
See Also:

  • Constructor Details

    • DisplayInput

      public DisplayInput()
      Instantiates a new display input with no highlight options.

    • DisplayInput

      public DisplayInput(@Nullable @Nullable DisplayInput.Highlight highlight)
      Creates an instance of a DisplayInput record class.
      Parameters:
      highlight - the value for the highlight 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.

    • highlight

      @Nullable public @Nullable DisplayInput.Highlight highlight()
      Returns the value of the highlight record component.
      Returns:
      the value of the highlight record component