org.codehaus.janino
Class Scanner

java.lang.Object
  org.codehaus.janino.Scanner

public class Scanner

extends Object

Splits up a character stream into tokens and returns them as String objects.

The optionalFileName parameter passed to many constructors should point

Nested Class Summary

class	Scanner.EOFToken
class	Scanner.IdentifierToken
class	Scanner.KeywordToken
class	Scanner.LiteralToken The type of the value parameter determines the type of the literal token: Type/value returned by Scanner.LiteralToken.getLiteralValue()Literal StringSTRING literal CharacterCHAR literal IntegerINT literal LongLONG literal FloatFLOAT literal DoubleDOUBLE literal BooleanBOOLEAN literal nullNULL literal
static class	Scanner.LocatedException
class	Scanner.OperatorToken
class	Scanner.ScanException An exception that reflects an error during parsing.
class	Scanner.Token

Field Summary

static Integer	MAGIC_INTEGER This value represents the "magic" literal "2147483648" which is only allowed in a negated context.
static Long	MAGIC_LONG This value represents the "magic" literal "9223372036854775808L" which is only allowed in a negated context.

Constructor Summary

Scanner(File file)
Set up a scanner that reads tokens from the given file in the platform default encoding.

Scanner(File file, String encoding)
Set up a scanner that reads tokens from the given file in the given encoding.

Scanner(String fileName)
Set up a scanner that reads tokens from the given file in the platform default encoding.

Scanner(String fileName, InputStream is)
Set up a scanner that reads tokens from the given InputStream in the platform default encoding.

Scanner(String optionalFileName, InputStream is, String optionalEncoding)
Set up a scanner that reads tokens from the given InputStream with the given optionalEncoding (null means platform default encoding).

Scanner(String optionalFileName, Reader in)
Set up a scanner that reads tokens from the given Reader.

Scanner(String optionalFileName, Reader in, short initialLineNumber, short initialColumnNumber)
Creates a Scanner that counts lines and columns from non-default initial values.

Method Summary

void	close() Closes the character source (file, InputStream, Reader) associated with this object.
String	doc() Get the text of the doc comment (a.k.a.
static String	literalValueToString(Object v)
Scanner.Token	peek() Peek the next token, but don't remove it from the input.
Scanner.Token	peekNextButOne() Peek the next but one token, neither remove the next nor the next but one token from the input.
Scanner.Token	read() Read the next token from the input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAGIC_INTEGER

public static final Integer MAGIC_INTEGER

This value represents the "magic" literal "2147483648" which is only allowed in a negated context.

MAGIC_LONG

public static final Long MAGIC_LONG

This value represents the "magic" literal "9223372036854775808L" which is only allowed in a negated context.

Constructor Detail

Scanner

public Scanner(String fileName)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given file in the platform default encoding.

Don't forget to close() when you're done, so the input file is closed.

Parameters:

fileName -

Throws:

Scanner.ScanException

IOException

Scanner

public Scanner(File file)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given file in the platform default encoding.

Don't forget to close() when you're done, so the input file is closed.

Parameters:

file -

Throws:

Scanner.ScanException

IOException

Scanner

public Scanner(File file,
               String encoding)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given file in the given encoding.

Don't forget to close() when you're done, so the input file is closed.

Parameters:

file -

encoding -

Throws:

Scanner.ScanException

IOException

Scanner

public Scanner(String fileName,
               InputStream is)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given InputStream in the platform default encoding.

The fileName is solely used for reporting in thrown exceptions.

Parameters:

fileName -

is -

Throws:

Scanner.ScanException

IOException

Scanner

public Scanner(String optionalFileName,
               InputStream is,
               String optionalEncoding)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given InputStream with the given optionalEncoding (null means platform default encoding).

The optionalFileName is used for reporting errors during compilation and for source level debugging, and should name an existing file. If null is passed, and the system property org.codehaus.janino.source_debugging.enable is set to "true", then a temporary file in org.codehaus.janino.source_debugging.dir or the system's default temp dir is created in order to make the source code available to a debugger.

Scanner

public Scanner(String optionalFileName,
               Reader in)
        throws Scanner.ScanException,
               IOException

Set up a scanner that reads tokens from the given Reader.

The optionalFileName is used for reporting errors during compilation and for source level debugging, and should name an existing file. If null is passed, and the system property org.codehaus.janino.source_debugging.enable is set to "true", then a temporary file in org.codehaus.janino.source_debugging.dir or the system's default temp dir is created in order to make the source code available to a debugger.

Scanner

public Scanner(String optionalFileName,
               Reader in,
               short initialLineNumber,
               short initialColumnNumber)
        throws Scanner.ScanException,
               IOException

Creates a Scanner that counts lines and columns from non-default initial values.

Method Detail

close

public void close()
           throws IOException

Closes the character source (file, InputStream, Reader) associated with this object. The results of future calls to peek() and read() are undefined.

Throws:

IOException

read

public Scanner.Token read()
                   throws Scanner.ScanException,
                          IOException

Read the next token from the input.

Throws:

Scanner.ScanException

IOException

peek

public Scanner.Token peek()

Peek the next token, but don't remove it from the input.

peekNextButOne

public Scanner.Token peekNextButOne()
                             throws Scanner.ScanException,
                                    IOException

Peek the next but one token, neither remove the next nor the next but one token from the input.

Throws:

Scanner.ScanException

IOException

doc

public String doc()

Get the text of the doc comment (a.k.a. "JAVADOC comment") preceeding the next token.

Returns:

null if the next token is not preceeded by a doc comment

literalValueToString

public static String literalValueToString(Object v)