Package org.codehaus.janino
Class TokenStreamImpl
- java.lang.Object
-
- org.codehaus.janino.TokenStreamImpl
-
- All Implemented Interfaces:
TokenStream
public class TokenStreamImpl extends java.lang.Object implements TokenStream
Standard implementation for theTokenStream
.
-
-
Constructor Summary
Constructors Constructor Description TokenStreamImpl(Scanner scanner)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CompileException
compileException(java.lang.String message)
Convenience method for throwing aCompileException
.java.lang.String
doc()
Gets the text of the doc comment (a.k.a.Location
location()
Token
peek()
boolean
peek(java.lang.String suspected)
int
peek(java.lang.String... suspected)
Checks whether the value of the next token equals any of the suspected; does not consume the next token.boolean
peek(TokenType suspected)
int
peek(TokenType... suspected)
Checks whether the type of the next token is any of the suspected; does not consume the next token.Token
peekNextButOne()
boolean
peekNextButOne(java.lang.String suspected)
boolean
peekRead(java.lang.String suspected)
Checks whether the value of the next token equals the suspected; if so, consumes the token.int
peekRead(java.lang.String... suspected)
Checks whether the value of the next token is one of the suspected; if so, consumes the token.java.lang.String
peekRead(TokenType suspected)
Checks whether the type of the next token is the suspected; if so, consumes the token.int
peekRead(TokenType... suspected)
Checks whether the type of the next token is one of the suspected; if so, consumes the token.Token
read()
void
read(java.lang.String expected)
Verifies that the value of the next token equals expected, and consumes the token.int
read(java.lang.String... expected)
Verifies that the value of the next token equals one of the expected, and consumes the token.java.lang.String
read(TokenType expected)
Verifies that the type of the next token is the expected, and consumes the token.int
read(TokenType... expected)
Verifies that the type of the next token is one of the expected, and consumes the token.void
setWarningHandler(WarningHandler warningHandler)
By default, warnings are discarded, but an application my install aWarningHandler
.java.lang.String
toString()
-
-
-
Constructor Detail
-
TokenStreamImpl
public TokenStreamImpl(Scanner scanner)
-
-
Method Detail
-
doc
@Nullable public java.lang.String doc()
Gets the text of the doc comment (a.k.a. "JAVADOC comment") preceding the next token.- Returns:
null
if the next token is not preceded by a doc comment
-
peek
public Token peek() throws CompileException, java.io.IOException
- Specified by:
peek
in interfaceTokenStream
- Returns:
- The next token, but does not consume it
- Throws:
CompileException
java.io.IOException
-
peekNextButOne
public Token peekNextButOne() throws CompileException, java.io.IOException
- Specified by:
peekNextButOne
in interfaceTokenStream
- Returns:
- The next-but-one token, but consumes neither the next nor the next-but-one token
- Throws:
CompileException
java.io.IOException
-
peek
public boolean peek(java.lang.String suspected) throws CompileException, java.io.IOException
- Specified by:
peek
in interfaceTokenStream
- Returns:
- Whether the value of the next token equals suspected; does not consume the next token
- Throws:
CompileException
java.io.IOException
-
peek
public int peek(java.lang.String... suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the value of the next token equals any of the suspected; does not consume the next token.- Specified by:
peek
in interfaceTokenStream
- Returns:
- The index of the first of the suspected that equals the value of the next token, or -1 if the value of the next token equals none of the suspected
- Throws:
CompileException
java.io.IOException
-
peek
public boolean peek(TokenType suspected) throws CompileException, java.io.IOException
- Specified by:
peek
in interfaceTokenStream
- Returns:
- Whether the type of the next token is suspected
- Throws:
CompileException
java.io.IOException
-
peek
public int peek(TokenType... suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the type of the next token is any of the suspected; does not consume the next token.- Specified by:
peek
in interfaceTokenStream
- Returns:
- The index of the first of the suspected types that is the next token's type, or -1 if the type of the next token is none of the suspected types
- Throws:
CompileException
java.io.IOException
-
peekNextButOne
public boolean peekNextButOne(java.lang.String suspected) throws CompileException, java.io.IOException
- Specified by:
peekNextButOne
in interfaceTokenStream
- Returns:
- Whether the value of the next-but-one token equals the suspected; consumes neither the next nor the next-but-one token
- Throws:
CompileException
java.io.IOException
-
read
public Token read() throws CompileException, java.io.IOException
- Specified by:
read
in interfaceTokenStream
- Returns:
- The next token, which it also consumes, or
null
iff the scanner is at end-of-input - Throws:
CompileException
java.io.IOException
-
read
public void read(java.lang.String expected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Verifies that the value of the next token equals expected, and consumes the token.- Specified by:
read
in interfaceTokenStream
- Throws:
CompileException
- The value of the next token does not equal expected (this includes the case that the scanner is at end-of-input)java.io.IOException
-
read
public int read(java.lang.String... expected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Verifies that the value of the next token equals one of the expected, and consumes the token.- Specified by:
read
in interfaceTokenStream
- Returns:
- The index of the consumed token within expected
- Throws:
CompileException
- The value of the next token does not equal any of the expected (this includes the case where the scanner is at end-of-input)java.io.IOException
-
read
public java.lang.String read(TokenType expected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Verifies that the type of the next token is the expected, and consumes the token.- Specified by:
read
in interfaceTokenStream
- Returns:
- The value of the next token; an
interned
String iff the token represents an identifier,true
,false
,null
, or an operator - Throws:
CompileException
- The next token's type is not the expectedjava.io.IOException
-
read
public int read(TokenType... expected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Verifies that the type of the next token is one of the expected, and consumes the token.- Specified by:
read
in interfaceTokenStream
- Returns:
- The index of the first of the expected types that is the next token's type; -1 if the type of the next token is none of the expected
- Throws:
CompileException
- The next token's type is none of the expectedjava.io.IOException
-
peekRead
public boolean peekRead(java.lang.String suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the value of the next token equals the suspected; if so, consumes the token.- Specified by:
peekRead
in interfaceTokenStream
- Throws:
CompileException
java.io.IOException
-
peekRead
public int peekRead(java.lang.String... suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the value of the next token is one of the suspected; if so, consumes the token.- Specified by:
peekRead
in interfaceTokenStream
- Returns:
- The index of the first of the suspected that equals the next token's value; -1 iff the next token's value equals none of the suspected
- Throws:
CompileException
java.io.IOException
-
peekRead
@Nullable public java.lang.String peekRead(TokenType suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the type of the next token is the suspected; if so, consumes the token.- Specified by:
peekRead
in interfaceTokenStream
- Returns:
- The value of the next token; an
interned
String iff the token represents an identifier,true
,false
,null
, or an operator - Throws:
CompileException
java.io.IOException
-
peekRead
public int peekRead(TokenType... suspected) throws CompileException, java.io.IOException
Description copied from interface:TokenStream
Checks whether the type of the next token is one of the suspected; if so, consumes the token.- Specified by:
peekRead
in interfaceTokenStream
- Returns:
- The index of the elements that is the next token's type, or -1 iff the type of next token is none of the suspected
- Throws:
CompileException
java.io.IOException
-
location
public Location location()
- Specified by:
location
in interfaceTokenStream
- Returns:
- The location of the first character of the previously read (not peeked!) token
-
setWarningHandler
public void setWarningHandler(@Nullable WarningHandler warningHandler)
Description copied from interface:TokenStream
By default, warnings are discarded, but an application my install aWarningHandler
.Notice that there is no
Parser.setErrorHandler()
method, but parse errors always throw aCompileException
. The reason being is that there is no reasonable way to recover from parse errors and continue parsing, so there is no need to install a custom parse error handler.- Specified by:
setWarningHandler
in interfaceTokenStream
- Parameters:
warningHandler
-null
to indicate that no warnings be issued
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
compileException
protected final CompileException compileException(java.lang.String message)
Convenience method for throwing aCompileException
.
-
-