org.antlr.v4.runtime.atn

Class LexerModeAction

java.lang.Object

org.antlr.v4.runtime.atn.LexerModeAction

All Implemented Interfaces:

LexerAction

public final class LexerModeAction
extends java.lang.Object
implements LexerAction

Implements the mode lexer action by calling Lexer.mode(int) with the assigned mode.

Since:

4.2

Constructor Summary

Constructors

Constructor and Description
LexerModeAction(int mode) Constructs a new mode action with the specified mode value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
void	execute(Lexer lexer) Execute the lexer action in the context of the specified Lexer.
LexerActionType	getActionType() Gets the serialization type of the lexer action.
int	getMode() Get the lexer mode this action should transition the lexer to.
int	hashCode()
boolean	isPositionDependent() Gets whether the lexer action is position-dependent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LexerModeAction

public LexerModeAction(int mode)

Constructs a new mode action with the specified mode value.

Parameters:

mode - The mode value to pass to Lexer.mode(int).

Method Detail

getMode

public int getMode()

Get the lexer mode this action should transition the lexer to.

Returns:

The lexer mode for this mode command.

getActionType

public LexerActionType getActionType()

Gets the serialization type of the lexer action.

Specified by:

getActionType in interface LexerAction

Returns:

This method returns LexerActionType.MODE.

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.mode(int) with the value provided by getMode().

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