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

Nested Classes

Modifier and Type	Class and Description
class	Scanner.Token Representation of a Java™ token.

Constructor Summary

Constructors

Constructor and Description
Scanner(File file) Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated
Scanner(File file, String optionalEncoding) Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated
Scanner(String fileName) Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated
Scanner(String optionalFileName, 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.
Scanner(String fileName, String encoding) Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated

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	doc() Get the text of the doc comment (a.k.a.
boolean	getExpectGreater()
String	getFileName()
Location	location()
Scanner.Token	produce() Preduces and returns the next token.
boolean	setExpectGreater(boolean value) Sets or resets the 'expect greater' mode.
void	setWarningHandler(WarningHandler optionalWarningHandler) By default, warnings are discarded, but an application my install a WarningHandler.

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 CompileException,
                            IOException

Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated

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

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

Throws:

CompileException

IOException

Scanner

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

Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated

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

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

Throws:

CompileException

IOException

Scanner

@Deprecated
public Scanner(File file)
                     throws CompileException,
                            IOException

Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated

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

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

Throws:

CompileException

IOException

Scanner

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

Deprecated. // SUPPRESS CHECKSTYLE MissingDeprecated

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

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

Throws:

CompileException

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               InputStream is)
        throws CompileException,
               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.

Throws:

CompileException

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               InputStream is,
               @Nullable
               String optionalEncoding)
        throws CompileException,
               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.

Throws:

CompileException

IOException

Scanner

public Scanner(@Nullable
               String optionalFileName,
               Reader in)
        throws CompileException,
               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.

Throws:

CompileException

IOException

Scanner

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

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

Throws:

CompileException

IOException

Method Detail

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

doc

@Nullable
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

location

public Location location()

Returns:

The Location of the next character

produce

public Scanner.Token produce()
                      throws CompileException,
                             IOException

Preduces and returns the next token. Notice that end-of-input is not signalized with a null product, but by the special Scanner.Token.EOF token.

Throws:

CompileException

IOException

getExpectGreater

public boolean getExpectGreater()

Returns:

Whether the scanner is currently in 'expect greater' mode

setExpectGreater

public boolean setExpectGreater(boolean value)

Sets or resets the 'expect greater' mode.

Returns:

Whether the 'expect greater' mode was previously active

setWarningHandler

public void setWarningHandler(@Nullable
                              WarningHandler optionalWarningHandler)

By default, warnings are discarded, but an application my install a WarningHandler.

Notice that there is no Scanner.setErrorHandler() method, but scan errors always throw a CompileException. The reason being is that there is no reasonable way to recover from scan errors and continue scanning, so there is no need to install a custom scan error handler.

Parameters:

optionalWarningHandler - null to indicate that no warnings be issued