Class LexerPushModeAction

  • All Implemented Interfaces:

    public final class LexerPushModeAction
    extends Object
    implements LexerAction
    Implements the pushMode lexer action by calling Lexer.pushMode(int) with the assigned mode.
    Sam Harwell
    • Constructor Detail

      • LexerPushModeAction

        public LexerPushModeAction​(int mode)
        Constructs a new pushMode action with the specified mode value.
        mode - The mode value to pass to Lexer.pushMode(int).
    • Method Detail

      • getMode

        public int getMode()
        Get the lexer mode this action should transition the lexer to.
        The lexer mode for this pushMode command.
      • 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
        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.pushMode(int) with the value provided by getMode().

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

        public int hashCode()
        hashCode in class Object