LookAheadLexer (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.lexer.Lexer
- - com.intellij.lexer.LexerBase
  - - com.intellij.lexer.LookAheadLexer

Direct Known Subclasses:

GroovyDocLexer, GroovyLexer, RegExpLexer, XPathLexer
```
public abstract class LookAheadLexer
extends LexerBase
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class LookAheadLexer.LookAheadLexerPosition

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`LookAheadLexer.LookAheadLexerPosition`

Constructor Summary

Constructors
Constructor and Description

LookAheadLexer(Lexer baseLexer)

LookAheadLexer(Lexer baseLexer, int capacity)

Constructors
Constructor and Description
`LookAheadLexer(Lexer baseLexer)`
`LookAheadLexer(Lexer baseLexer, int capacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToken(IElementType type)`
`protected void`	`addToken(int endOffset, IElementType type)`
`void`	`advance()` Advances the lexer to the next token.
`protected void`	`advanceAs(Lexer lexer, IElementType type)`
`protected void`	`advanceLexer(Lexer lexer)`
`int`	`getBufferEnd()` Returns the offset at which the lexer will stop lexing.
`java.lang.CharSequence`	`getBufferSequence()` Returns the buffer sequence over which the lexer is running.
`protected int`	`getCachedOffset(int index)`
`protected IElementType`	`getCachedType(int index)`
`protected int`	`getCacheSize()`
`LookAheadLexer.LookAheadLexerPosition`	`getCurrentPosition()` Returns the current position and state of the lexer.
`int`	`getState()` Returns the current state of the lexer.
`int`	`getTokenEnd()` Returns the end offset of the current token.
`int`	`getTokenStart()` Returns the start offset of the current token.
`IElementType`	`getTokenType()` Returns the token at the current position of the lexer or `null` if lexing is finished.
`protected void`	`lookAhead(Lexer baseLexer)`
`IElementType`	`replaceCachedType(int index, IElementType token)`
`protected void`	`resetCacheSize(int size)`
`void`	`restore(LexerPosition _position)` Restores the lexer to the specified state and position.
`protected void`	`restore(LookAheadLexer.LookAheadLexerPosition position)`
`void`	`start(java.lang.CharSequence buffer, int startOffset, int endOffset, int initialState)` Prepare for lexing character data from `buffer` passed.

Methods inherited from class com.intellij.lexer.Lexer
getTokenSequence, getTokenText, start, start

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LookAheadLexer
```
public LookAheadLexer(Lexer baseLexer,
                      int capacity)
```
  - LookAheadLexer
```
public LookAheadLexer(Lexer baseLexer)
```
- Method Detail
  - addToken
```
protected void addToken(IElementType type)
```
  - addToken
```
protected void addToken(int endOffset,
                        IElementType type)
```
  - lookAhead
```
protected void lookAhead(Lexer baseLexer)
```
  - advance
```
public void advance()
```
    Description copied from class: Lexer
    
    Advances the lexer to the next token.
    
    Specified by:
    
    advance in class Lexer
  - getBufferSequence
```
public java.lang.CharSequence getBufferSequence()
```
    Description copied from class: Lexer
    
    Returns the buffer sequence over which the lexer is running. This method should return the same buffer instance which was passed to the start() method.
    
    Specified by:
    
    getBufferSequence in class Lexer
    
    Returns:
    
    the lexer buffer.
  - getBufferEnd
```
public int getBufferEnd()
```
    Description copied from class: Lexer
    
    Returns the offset at which the lexer will stop lexing. This method should return the length of the buffer or the value passed in the endOffset parameter to the start() method.
    
    Specified by:
    
    getBufferEnd in class Lexer
    
    Returns:
    
    the lexing end offset
  - getCacheSize
```
protected int getCacheSize()
```
  - resetCacheSize
```
protected void resetCacheSize(int size)
```
  - replaceCachedType
```
public IElementType replaceCachedType(int index,
                                      IElementType token)
```
  - getCachedType
```
protected final IElementType getCachedType(int index)
```
  - getCachedOffset
```
protected final int getCachedOffset(int index)
```
  - getState
```
public int getState()
```
    Description copied from class: Lexer
    
    Returns the current state of the lexer.
    
    Specified by:
    
    getState in class Lexer
    
    Returns:
    
    the lexer state.
  - getTokenEnd
```
public int getTokenEnd()
```
    Description copied from class: Lexer
    
    Returns the end offset of the current token.
    
    Specified by:
    
    getTokenEnd in class Lexer
    
    Returns:
    
    the current token end offset.
  - getTokenStart
```
public int getTokenStart()
```
    Description copied from class: Lexer
    
    Returns the start offset of the current token.
    
    Specified by:
    
    getTokenStart in class Lexer
    
    Returns:
    
    the current token start offset.
  - getCurrentPosition
```
public LookAheadLexer.LookAheadLexerPosition getCurrentPosition()
```
    Description copied from class: Lexer
    
    Returns the current position and state of the lexer.
    
    Overrides:
    
    getCurrentPosition in class LexerBase
    
    Returns:
    
    the lexer position and state.
  - restore
```
public final void restore(LexerPosition _position)
```
    Description copied from class: Lexer
    
    Restores the lexer to the specified state and position.
    
    Overrides:
    
    restore in class LexerBase
    
    Parameters:
    
    _position - the state and position to restore to.
  - restore
```
protected void restore(LookAheadLexer.LookAheadLexerPosition position)
```
  - getTokenType
```
public IElementType getTokenType()
```
    Description copied from class: Lexer
    
    Returns the token at the current position of the lexer or null if lexing is finished.
    
    Specified by:
    
    getTokenType in class Lexer
    
    Returns:
    
    the current token.
  - start
```
public void start(java.lang.CharSequence buffer,
                  int startOffset,
                  int endOffset,
                  int initialState)
```
    Description copied from class: Lexer
    
    Prepare for lexing character data from buffer passed. Internal lexer state is supposed to be initialState. It is guaranteed that the value of initialState is the same as returned by Lexer.getState() method of this lexer at condition startOffset=getTokenStart(). This method is used to incrementally re-lex changed characters using lexing data acquired from this particular lexer sometime in the past.
    
    Specified by:
    
    start in class Lexer
    
    Parameters:
    
    buffer - character data for lexing.
    
    startOffset - offset to start lexing from
    
    endOffset - offset to stop lexing at
    
    initialState - the initial state of the lexer.
  - advanceLexer
```
protected final void advanceLexer(Lexer lexer)
```
  - advanceAs
```
protected final void advanceAs(Lexer lexer,
                               IElementType type)
```

Class LookAheadLexer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.intellij.lexer.Lexer

Methods inherited from class java.lang.Object

Constructor Detail

LookAheadLexer

LookAheadLexer

Method Detail

addToken

addToken

lookAhead

advance

getBufferSequence

getBufferEnd

getCacheSize

resetCacheSize

replaceCachedType

getCachedType

getCachedOffset

getState

getTokenEnd

getTokenStart

getCurrentPosition

restore

restore

getTokenType

start

advanceLexer

advanceAs