Top Description Fields Constructors Methods
org.antlr.v4.runtime.atn

public final Class LexerChannelAction

extends Object
implements LexerAction
Class Inheritance
All Implemented Interfaces
org.antlr.v4.runtime.atn.LexerAction
Imports
org.antlr.v4.runtime.Lexer, .Token, org.antlr.v4.runtime.misc.MurmurHash

Implements the channel lexer action by calling Lexer#setChannel with the assigned channel.
Author
Sam Harwell
Since
4.2

Field Summary

Modifier and TypeField and Description
private final int

Constructor Summary

AccessConstructor and Description
public
LexerChannelAction(int
The channel value to pass to Lexer#setChannel.
channel
)

Constructs a new channel action with the specified channel value.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public void
execute(Lexer
The lexer instance.
lexer
)

Implements org.antlr.v4.runtime.atn.LexerAction.execute.

Execute the lexer action in the context of the specified Lexer.
public LexerActionType

Returns:

This method returns LexerActionType#CHANNEL.
getActionType
()

Implements org.antlr.v4.runtime.atn.LexerAction.getActionType.

Gets the serialization type of the lexer action.
public int

Returns:

The channel to use for the Token created by the lexer.
getChannel
()

Gets the channel to use for the Token created by the lexer.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean

Returns:

This method returns false.
isPositionDependent
()

Implements org.antlr.v4.runtime.atn.LexerAction.isPositionDependent.

Gets whether the lexer action is position-dependent.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

channelback to summary
private final int channel

Constructor Detail

LexerChannelActionback to summary
public LexerChannelAction(int channel)

Constructs a new channel action with the specified channel value.

Parameters
channel:int

The channel value to pass to Lexer#setChannel.

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
executeback to summary
public void execute(Lexer lexer)

Implements org.antlr.v4.runtime.atn.LexerAction.execute.

Doc from org.antlr.v4.runtime.atn.LexerAction.execute.

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#setChannel with the value provided by getChannel.

Parameters
lexer:Lexer

The lexer instance.

Annotations
@Override
getActionTypeback to summary
public LexerActionType getActionType()

Implements org.antlr.v4.runtime.atn.LexerAction.getActionType.

Doc from org.antlr.v4.runtime.atn.LexerAction.getActionType.

Gets the serialization type of the lexer action.

Returns:LexerActionType

This method returns LexerActionType#CHANNEL.

Annotations
@Override
getChannelback to summary
public int getChannel()

Gets the channel to use for the Token created by the lexer.

Returns:int

The channel to use for the Token created by the lexer.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isPositionDependentback to summary
public boolean isPositionDependent()

Implements org.antlr.v4.runtime.atn.LexerAction.isPositionDependent.

Doc from org.antlr.v4.runtime.atn.LexerAction.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.

Returns:boolean

This method returns false.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override