Interface Tok

core/src/main/java/com/google/googlejavaformat/Input.java:29–74

A Tok ("tock") is a token, or a comment, or a newline, or a maximal string of blanks. A token Tok underlies a Token, and each other Tok is attached to a single Token. Tokens and comments have indices; white space Toks do not.

   * {@code Token}. Tokens and comments have indices; white space {@code Tok}s do not.
   */
  public interface Tok {
    /**
     * Return the {@code Tok}'s index.
     *
     * @return its index
     */
    int getIndex();

    /**
     * Return the {@code Tok}'s {@code 0}-based position.
     *
     * @return its position
     */
    int getPosition();

    /**
     * Return the {@code Tok}'s {@code 0}-based column number.
     *
     * @return its column number
     */
    int getColumn();

    /** The {@code Tok}'s text. */
    String getText();

    /** The {@code Tok}'s original text (before processing escapes). */
    String getOriginalText();

    /** The length of the {@code Tok}'s original text. */
    int length();

    /** Is the {@code Tok} a newline? */
    boolean isNewline();

    /** Is the {@code Tok} a "//" comment? */
    boolean isSlashSlashComment();

    /** Is the {@code Tok} a "/*" comment? */
    boolean isSlashStarComment();

    /** Is the {@code Tok} a javadoc comment? */
    boolean isJavadocComment();

    /** Is the {@code Tok} a comment? */
    boolean isComment();
  }

  /** A {@code Token} is a language-level token. */
  public interface Token {