com.github.sbaudoin.sonar.plugins.shellcheck.lexer

Interface ShellLexer

All Known Implementing Classes:

BashLexer

public interface ShellLexer

Shell lexers should implement this interface. Implementations should pay attention to the expected role of the constructors: some must offer all necessary parameters so that the scan() and next() methods can work as expected, without parameters.

Method Summary

Modifier and Type	Method and Description
Token	getToken() Returns the token just read with next() or null if no token read yet, scan() was called or the last token was reached (i.e.
Token	next() Contrary to the scan() method, the tokens are returned one by one by this method: it resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O error occurs
List<Token>	scan() Returns all non-overlapping found tokens for each recognized token in the stream set by the constructor.

Method Detail

scan

List<Token> scan()
          throws IOException

Returns all non-overlapping found tokens for each recognized token in the stream set by the constructor.

Returns:

the list of Tokens found in the script

Throws:

IOException - if an error occurred reading the input script

next

Token next()
    throws IOException

Contrary to the scan() method, the tokens are returned one by one by this method: it resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O error occurs

Returns:

the next token

Throws:

IOException - if any I/O error occurs

getToken

Token getToken()

Returns the token just read with next() or null if no token read yet, scan() was called or the last token was reached (i.e. no more token left)

Returns:

the token just read with next() or null if no token read yet, scan() was called or the last token was reached (i.e. no more token left)