Package com.io7m.jlexing.core

Class LexicalPosition.Builder<F>

java.lang.Object
com.io7m.jlexing.core.LexicalPosition.Builder<F>
Enclosing class:
LexicalPosition<F>
public static final class LexicalPosition.Builder<F> extends Object
Builds instances of type LexicalPosition. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • from

      public final LexicalPosition.Builder<F> from(LexicalPositionType<F> instance)
      Fill a builder with attribute values from the provided LexicalPositionType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • setLine

      public final LexicalPosition.Builder<F> setLine(int line)
      Initializes the value for the line attribute.
      Parameters:
      line - The value for line
      Returns:
      this builder for use in a chained invocation

    • setColumn

      public final LexicalPosition.Builder<F> setColumn(int column)
      Initializes the value for the column attribute.
      Parameters:
      column - The value for column
      Returns:
      this builder for use in a chained invocation

    • setFile

      public final LexicalPosition.Builder<F> setFile(F file)
      Initializes the optional value file to file.
      Parameters:
      file - The value for file
      Returns:
      this builder for chained invocation

    • setFile

      public final LexicalPosition.Builder<F> setFile(Optional<? extends F> file)
      Initializes the optional value file to file.
      Parameters:
      file - The value for file
      Returns:
      this builder for use in a chained invocation

    • setColumnEnd

      public final LexicalPosition.Builder<F> setColumnEnd(int columnEnd)
      Initializes the value for the columnEnd attribute.

      If not set, this attribute will have a default value as returned by the initializer of columnEnd.

      Parameters:
      columnEnd - The value for columnEnd
      Returns:
      this builder for use in a chained invocation

    • build

      public LexicalPosition<F> build()
      Builds a new LexicalPosition.
      Returns:
      An immutable instance of LexicalPosition
      Throws:
      IllegalStateException - if any required attributes are missing