de.unkrig.commons.text.scanner

Class JavaScanner

java.lang.Object

de.unkrig.commons.text.scanner.JavaScanner

public final class JavaScanner
extends java.lang.Object

A scanner for the JAVA programming language.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaScanner.TokenType Token types of the JAVA programming language.

Method Summary

Modifier and Type	Method and Description
static ProducerWhichThrows<AbstractScanner.Token<JavaScanner.TokenType>,ScanException>	combineMultiLineCComments(ProducerWhichThrows<? extends AbstractScanner.Token<JavaScanner.TokenType>,? extends ScanException> delegate) Creates and returns a token producer that combines JavaScanner.TokenType.MULTI_LINE_C_COMMENT_BEGINNING, JavaScanner.TokenType.MULTI_LINE_C_COMMENT_MIDDLE and JavaScanner.TokenType.MULTI_LINE_C_COMMENT_END tokens that the delegate produces into a single JavaScanner.TokenType.C_COMMENT.
static ProducerWhichThrows<AbstractScanner.Token<JavaScanner.TokenType>,ScanException>	compressSpaces(ProducerWhichThrows<? extends AbstractScanner.Token<JavaScanner.TokenType>,? extends ScanException> delegate) Creates and returns a token producer that merges sequences of two or more JavaScanner.TokenType.SPACE tokens into one.
static StringScanner<JavaScanner.TokenType>	rawStringScanner() Returns a Java scanner that also produces SPACE and COMMENT tokens.
static StringScanner<JavaScanner.TokenType>	stringScanner()
static java.io.Reader	unicodeEscapesDecodingReader(java.io.Reader delegate) A FilterReader that recognizes "unicode escapes" (backslash, 'u' and four hex digits), and decodes them on-the-fly.

Methods inherited from class java.lang.Object

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

Method Detail

rawStringScanner

public static StringScanner<JavaScanner.TokenType> rawStringScanner()

Returns a Java scanner that also produces SPACE and COMMENT tokens. Multi-line C-style comments are returned as two or more tokens, as follows:

   MULTI_LINE_C_COMMENT_BEGINNING { MULTI_LINE_C_COMMENT_MIDDLE } MULTI_LINE_C_COMMENT_END
 

stringScanner

public static StringScanner<JavaScanner.TokenType> stringScanner()

Returns:

A StringScanner that swallows SPACE and COMMENT tokens

combineMultiLineCComments

public static ProducerWhichThrows<AbstractScanner.Token<JavaScanner.TokenType>,ScanException> combineMultiLineCComments(ProducerWhichThrows<? extends AbstractScanner.Token<JavaScanner.TokenType>,? extends ScanException> delegate)

Creates and returns a token producer that combines JavaScanner.TokenType.MULTI_LINE_C_COMMENT_BEGINNING, JavaScanner.TokenType.MULTI_LINE_C_COMMENT_MIDDLE and JavaScanner.TokenType.MULTI_LINE_C_COMMENT_END tokens that the delegate produces into a single JavaScanner.TokenType.C_COMMENT.

compressSpaces

public static ProducerWhichThrows<AbstractScanner.Token<JavaScanner.TokenType>,ScanException> compressSpaces(ProducerWhichThrows<? extends AbstractScanner.Token<JavaScanner.TokenType>,? extends ScanException> delegate)

Creates and returns a token producer that merges sequences of two or more JavaScanner.TokenType.SPACE tokens into one.

unicodeEscapesDecodingReader

public static java.io.Reader unicodeEscapesDecodingReader(java.io.Reader delegate)

A FilterReader that recognizes "unicode escapes" (backslash, 'u' and four hex digits), and decodes them on-the-fly.

See Also:

The Java Language Specification, Section 3.3, "Unicode Escapes"