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.

Constructor Summary

Constructors

Constructor and Description
Scanner(File file) Deprecated. This method is deprecated because it leaves the input file open
Scanner(File file, String optionalEncoding) Deprecated. This method is deprecated because it leaves the input file open
Scanner(String fileName) Deprecated. This method is deprecated because it leaves the input file open
Scanner(String optionalFileName, InputStream is) Sets up a scanner that reads tokens from the given InputStream in the platform default encoding.
Scanner(String optionalFileName, InputStream is, String optionalEncoding) Sets up a scanner that reads tokens from the given InputStream with the given optionalEncoding (null means platform default encoding).
Scanner(String optionalFileName, Reader in) Sets up a scanner that reads tokens from the given Reader.
Scanner(String optionalFileName, Reader in, int initialLineNumber, int initialColumnNumber) Creates a Scanner that counts lines and columns from non-default initial values.
Scanner(String fileName, String encoding) Deprecated. This method is deprecated because it leaves the input file open

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated. This method is deprecated, because the concept described above is confusing. An application should close the underlying InputStream or Reader itself
String	getFileName()
Location	location()
Token	produce() Produces and returns the next token.
void	setIgnoreWhiteSpace(boolean value) If value is true, then white space in the input stream is ignored, rather than scanned as a TokenType.WHITE_SPACE token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scanner

@Deprecated
public Scanner(String fileName)
                     throws IOException

Deprecated. This method is deprecated because it leaves the input file open

Throws:

IOException

Scanner

@Deprecated
public Scanner(String fileName,
                            String encoding)
                     throws IOException

Deprecated. This method is deprecated because it leaves the input file open

Throws:

IOException

Scanner

@Deprecated
public Scanner(File file)
                     throws IOException

Deprecated. This method is deprecated because it leaves the input file open

Throws:

IOException

Scanner

@Deprecated
public Scanner(File file,
                            @Nullable
                            String optionalEncoding)
                     throws IOException

Deprecated. This method is deprecated because it leaves the input file open

Throws:

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               InputStream is)
        throws IOException

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

Throws:

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               InputStream is,
               @Nullable
               String optionalEncoding)
        throws IOException

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

Throws:

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               Reader in)
        throws IOException

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

Throws:

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               Reader in,
               int initialLineNumber,
               int initialColumnNumber)
        throws IOException

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

Throws:

IOException

Method Detail

setIgnoreWhiteSpace

public void setIgnoreWhiteSpace(boolean value)

If value is true, then white space in the input stream is ignored, rather than scanned as a TokenType.WHITE_SPACE token. Since white space is typically quite numerous, this optimization may save considerable overhead.

getFileName

@Nullable
public String getFileName()

Returns:

The file name optionally passed to the constructor

close

@Deprecated
public void close()
                        throws IOException

Deprecated. This method is deprecated, because the concept described above is confusing. An application should close the underlying InputStream or Reader itself

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

Throws:

IOException

location

public Location location()

Returns:

The Location of the previously read (or peeked) token.

produce

public Token produce()
              throws CompileException,
                     IOException

Produces and returns the next token. Notice that end-of-input is not signalized with a null product, but by an TokenType.END_OF_INPUT-type token.

Throws:

CompileException

IOException