Class LexerSkipAction

  • All Implemented Interfaces:
    LexerAction

    public final class LexerSkipAction
    extends java.lang.Object
    implements LexerAction
    Implements the skip lexer action by calling Lexer.skip().

    The skip command does not have any parameters, so this action is implemented as a singleton instance exposed by INSTANCE.

    Since:
    4.2
    Author:
    Sam Harwell
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static LexerSkipAction INSTANCE
      Provides a singleton instance of this parameterless lexer action.
    • Field Detail

      • INSTANCE

        public static final LexerSkipAction INSTANCE
        Provides a singleton instance of this parameterless lexer action.
    • Method Detail

      • isPositionDependent

        public boolean isPositionDependent()
        Gets whether the lexer action is position-dependent. Position-dependent actions may have different semantics depending on the CharStream index at the time the action is executed.

        Many lexer commands, including type, skip, and more, do not check the input index during their execution. Actions like this are position-independent, and may be stored more efficiently as part of the LexerATNConfig.lexerActionExecutor.

        Specified by:
        isPositionDependent in interface LexerAction
        Returns:
        This method returns false.
      • execute

        public void execute​(Lexer lexer)
        Execute the lexer action in the context of the specified Lexer.

        For position-dependent actions, the input stream must already be positioned correctly prior to calling this method.

        This action is implemented by calling Lexer.skip().

        Specified by:
        execute in interface LexerAction
        Parameters:
        lexer - The lexer instance.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object