com.sun.tools.javac.parser

Class JavadocTokenizer

java.lang.Object

com.sun.tools.javac.parser.JavaTokenizer

com.sun.tools.javac.parser.JavadocTokenizer

public class JavadocTokenizer
extends JavaTokenizer

An extension to the base lexical analyzer that captures and processes the contents of doc comments. It does so by translating Unicode escape sequences and by stripping the leading whitespace and starts from each line of the comment.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JavadocTokenizer.JavadocComment

Nested classes/interfaces inherited from class com.sun.tools.javac.parser.JavaTokenizer

JavaTokenizer.BasicComment<U extends UnicodeReader>

Field Summary

Fields inherited from class com.sun.tools.javac.parser.JavaTokenizer

errPos, fac, name, radix, reader, tk

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavadocTokenizer(ScannerFactory fac, char[] input, int inputLength) Create a scanner from the input array.
protected	JavadocTokenizer(ScannerFactory fac, CharBuffer buffer) Create a scanner from the input buffer.

Method Summary

Modifier and Type	Method and Description
Position.LineMap	getLineMap() Build a map for translating between line numbers and positions in the input.
protected Tokens.Comment	processComment(int pos, int endPos, Tokens.Comment.CommentStyle style) Called when a complete comment has been scanned.

Methods inherited from class com.sun.tools.javac.parser.JavaTokenizer

errPos, errPos, lexError, processLineTerminator, processWhiteSpace, readToken

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocTokenizer

protected JavadocTokenizer(ScannerFactory fac,
                           CharBuffer buffer)

Create a scanner from the input buffer. buffer must implement array() and compact(), and remaining() must be less than limit().

JavadocTokenizer

protected JavadocTokenizer(ScannerFactory fac,
                           char[] input,
                           int inputLength)

Create a scanner from the input array. The array must have at least a single character of extra space.

Method Detail

processComment

protected Tokens.Comment processComment(int pos,
                                        int endPos,
                                        Tokens.Comment.CommentStyle style)

Description copied from class: JavaTokenizer

Called when a complete comment has been scanned. pos and endPos will mark the comment boundary.

Overrides:

processComment in class JavaTokenizer

getLineMap

public Position.LineMap getLineMap()

Description copied from class: JavaTokenizer

Build a map for translating between line numbers and positions in the input.

Overrides:

getLineMap in class JavaTokenizer

Returns:

a LineMap