ANTLR 4 Runtime 4.13.1 · org.antlr.v4.runtime.atn.LexerIndexedCustomAction

Modifier and Type	Field and Description
private final LexerAction	action
private final int	offset

Access	Constructor and Description
public	LexerIndexedCustomAction(int The offset into the input `CharStream`, relative to the token start index, at which the specified lexer action should be executed. offset, LexerAction The lexer action to execute at a particular offset in the input `CharStream`. action) Constructs a new indexed custom action by associating a character offset with a `LexerAction`.

Method Summary

Modifier and Type	Method 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 LexerAction	Returns: A `LexerAction` object which executes the lexer action. getAction() Gets the lexer action to execute.
public LexerActionType	Returns: This method returns the result of calling `getActionType` on the `LexerAction` returned by `getAction`. getActionType() Implements org.antlr.v4.runtime.atn.LexerAction.getActionType. Gets the serialization type of the lexer action.
public int	Returns: The location in the input `CharStream` at which the lexer action should be executed. getOffset() Gets the location in the input `CharStream` at which the lexer action should be executed.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	Returns: This method returns `true`. isPositionDependent() Implements org.antlr.v4.runtime.atn.LexerAction.isPositionDependent. Gets whether the lexer action is position-dependent.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

action	back to summary
private final LexerAction action

offset	back to summary
private final int offset

LexerIndexedCustomAction	back to summary
public LexerIndexedCustomAction(int offset, LexerAction action) Constructs a new indexed custom action by associating a character offset with a `LexerAction`. Note This class is only required for lexer actions for which `LexerAction#isPositionDependent` returns `true`. Parameters offset:int The offset into the input `CharStream`, relative to the token start index, at which the specified lexer action should be executed. action:LexerAction The lexer action to execute at a particular offset in the input `CharStream`.

Method Detail

equals back to summary

equals	back 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

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

execute back to summary

execute	back 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 method calls `execute` on the result of `getAction` using the provided `lexer`. Parameters lexer:Lexer The lexer instance. Annotations @Override

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 method calls execute on the result of getAction using the provided lexer.

Parameters

lexer:Lexer: The lexer instance.

Annotations

@Override

getAction back to summary

getAction	back to summary
public LexerAction getAction() Gets the lexer action to execute. Returns:LexerAction A `LexerAction` object which executes the lexer action.

public LexerAction getAction()

Gets the lexer action to execute.

Returns:LexerAction: A LexerAction object which executes the lexer action.

getActionType back to summary

getActionType	back 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 the result of calling `getActionType` on the `LexerAction` returned by `getAction`. Annotations @Override

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 the result of calling getActionType on the LexerAction returned by getAction.

Annotations

@Override

getOffset back to summary

getOffset	back to summary
public int getOffset() Gets the location in the input `CharStream` at which the lexer action should be executed. The value is interpreted as an offset relative to the token start index. Returns:int The location in the input `CharStream` at which the lexer action should be executed.

public int getOffset()

Gets the location in the input CharStream at which the lexer action should be executed. The value is interpreted as an offset relative to the token start index.

Returns:int: The location in the input CharStream at which the lexer action should be executed.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the 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

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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

isPositionDependent back to summary

isPositionDependent	back 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 `true`. Annotations @Override

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 true.

Annotations

@Override

public final Class LexerIndexedCustomAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail