Top Description Methods
org.antlr.v4.runtime

public Interface Vocabulary

Known Direct Implementers
org.antlr.v4.runtime.VocabularyImpl
Imports
org.antlr.v4.runtime.misc.NotNull, .Nullable
This interface provides information about the vocabulary used by a recognizer.
Author
Sam Harwell
See Also
Recognizer#getVocabulary()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The display name of the token type, for use in error reporting or other user-visible messages which reference specific token types.
getDisplayName(int
The token type.
tokenType)

Gets the display name of a token type.

public String

Returns:

The string literal associated with the specified token type, or null if no string literal is associated with the type.
getLiteralName(int
The token type.
tokenType)

Gets the string literal associated with a token type.

public int

Returns:

the highest token type value
getMaxTokenType()

Returns the highest token type value.

public String

Returns:

The symbolic name associated with the specified token type, or null if no symbolic name is associated with the type.
getSymbolicName(int
The token type.
tokenType)

Gets the symbolic name associated with a token type.

Method Detail

getDisplayNameback to summary
public String getDisplayName(int tokenType)

Gets the display name of a token type.

ANTLR provides a default implementation of this method, but applications are free to override the behavior in any manner which makes sense for the application. The default implementation returns the first result from the following list which produces a non-null result.

  1. The result of getLiteralName
  2. The result of getSymbolicName
  3. The result of Integer#toString
Parameters
tokenType:int

The token type.

Returns:String

The display name of the token type, for use in error reporting or other user-visible messages which reference specific token types.

Annotations
@NotNull
getLiteralNameback to summary
public String getLiteralName(int tokenType)

Gets the string literal associated with a token type. The string returned by this method, when not null, can be used unaltered in a parser grammar to represent this token type.

The following table shows examples of lexer rules and the literal names assigned to the corresponding token types.

Rule Literal Name Java String Literal
THIS : 'this'; 'this' "'this'"
SQUOTE : '\''; '\'' "'\\''"
ID : [A-Z]+; n/a null
Parameters
tokenType:int

The token type.

Returns:String

The string literal associated with the specified token type, or null if no string literal is associated with the type.

Annotations
@Nullable
getMaxTokenTypeback to summary
public int getMaxTokenType()

Returns the highest token type value. It can be used to iterate from zero to that number, inclusively, thus querying all stored entries.

Returns:int

the highest token type value

getSymbolicNameback to summary
public String getSymbolicName(int tokenType)

Gets the symbolic name associated with a token type. The string returned by this method, when not null, can be used unaltered in a parser grammar to represent this token type.

This method supports token types defined by any of the following methods:

  • Tokens created by lexer rules.
  • Tokens defined in a tokens{} block in a lexer or parser grammar.
  • The implicitly defined EOF token, which has the token type Token#EOF.

The following table shows examples of lexer rules and the literal names assigned to the corresponding token types.

Rule Symbolic Name
THIS : 'this'; THIS
SQUOTE : '\''; SQUOTE
ID : [A-Z]+; ID
Parameters
tokenType:int

The token type.

Returns:String

The symbolic name associated with the specified token type, or null if no symbolic name is associated with the type.

Annotations
@Nullable