| java.lang.Object
 com.sun.tools.javac.parser.Scanner
All known Subclasses: com.sun.tools.javac.parser.DocCommentScanner,
| Scanner | | public class Scanner implements Lexer(Code) | | The lexical analyzer maps an input stream consisting of
ASCII characters and Unicode escapes into a token sequence.
This is NOT part of any API supported by Sun Microsystems. 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.
|
| Inner Class :public static class Factory | |
| Inner Class :public enum CommentStyle | |
| Field Summary | |
| protected boolean | deprecatedFlag
Has a @deprecated been encountered in last doc comment?
this needs to be reset by client. | | final static boolean | surrogatesSupported
|
| Constructor Summary | |
| protected | Scanner(Factory fac, CharBuffer buffer)
Create a scanner from the input buffer. | | protected | Scanner(Factory fac, char[] input, int inputLength)
Create a scanner from the input array. |
| Method Summary | |
| public boolean | deprecatedFlag()
Has a @deprecated been encountered in last doc comment?
This needs to be reset by client with resetDeprecatedFlag. | | public String | docComment()
Returns the documentation string of the current token. | | public int | endPos()
Return the last character position of the current token. | | public int | errPos()
| | public void | errPos(int pos)
| | public Position.LineMap | getLineMap()
Build a map for translating between line numbers and
positions in the input. | | public char[] | getRawCharacters()
Returns a copy of the input buffer, up to its inputLength. | | public char[] | getRawCharacters(int beginIndex, int endIndex)
Returns a copy of a character array subset of the input buffer. | | public Name | name()
Return the name of an identifier or token for the current token. | | public void | nextToken()
Read token. | | public int | pos()
| | public int | prevEndPos()
Return the last character position of the previous token. | | protected void | processComment(CommentStyle style)
Called when a complete comment has been scanned. | | protected void | processLineTerminator()
Called when a line terminator has been processed. | | protected void | processWhiteSpace()
Called when a complete whitespace run has been scanned. | | public int | radix()
Return the radix of a numeric literal token. | | public void | resetDeprecatedFlag()
| | public String | stringVal()
The value of a literal token, recorded as a string. | | public Token | token()
Return the current token, set by nextToken(). | | public void | token(Token token)
Sets the current token. |
| deprecatedFlag | | protected boolean deprecatedFlag(Code) | | Has a @deprecated been encountered in last doc comment?
this needs to be reset by client.
|
| surrogatesSupported | | final static boolean surrogatesSupported(Code) | | Are surrogates supported?
|
| Scanner | | protected Scanner(Factory fac, CharBuffer buffer)(Code) | | Create a scanner from the input buffer. buffer must implement
array() and compact(), and remaining() must be less than limit().
|
| Scanner | | protected Scanner(Factory fac, char[] input, int inputLength)(Code) | | Create a scanner from the input array. This method might
modify the array. To avoid copying the input array, ensure
that
inputLength < input.length or
input[input.length -1] is a white space character.
Parameters:
fac - the factory which created this Scanner
Parameters:
input - the input, might be modified
Parameters:
inputLength - the size of the input.Must be positive and less than or equal to input.length. |
| deprecatedFlag | | public boolean deprecatedFlag()(Code) | | Has a @deprecated been encountered in last doc comment?
This needs to be reset by client with resetDeprecatedFlag.
|
| docComment | | public String docComment()(Code) | | Returns the documentation string of the current token.
|
| endPos | | public int endPos()(Code) | | Return the last character position of the current token.
|
| errPos | | public int errPos()(Code) | | Return the position where a lexical error occurred;
|
| errPos | | public void errPos(int pos)(Code) | | Set the position where a lexical error occurred;
|
| getLineMap | | public Position.LineMap getLineMap()(Code) | | Build a map for translating between line numbers and
positions in the input.
a LineMap |
| getRawCharacters | | public char[] getRawCharacters()(Code) | | Returns a copy of the input buffer, up to its inputLength.
Unicode escape sequences are not translated.
|
| getRawCharacters | | public char[] getRawCharacters(int beginIndex, int endIndex)(Code) | | Returns a copy of a character array subset of the input buffer.
The returned array begins at the beginIndex and
extends to the character at index endIndex - 1.
Thus the length of the substring is endIndex-beginIndex.
This behavior is like
String.substring(beginIndex, endIndex).
Unicode escape sequences are not translated.
Parameters:
beginIndex - the beginning index, inclusive.
Parameters:
endIndex - the ending index, exclusive.
throws:
IndexOutOfBounds - if either offset is outside of thearray bounds |
| name | | public Name name()(Code) | | Return the name of an identifier or token for the current token.
|
| nextToken | | public void nextToken()(Code) | | Read token.
|
| pos | | public int pos()(Code) | | Return the current token's position: a 0-based
offset from beginning of the raw input stream
(before unicode translation)
|
| prevEndPos | | public int prevEndPos()(Code) | | Return the last character position of the previous token.
|
| processComment | | protected void processComment(CommentStyle style)(Code) | | Called when a complete comment has been scanned. pos and endPos
will mark the comment boundary.
|
| processLineTerminator | | protected void processLineTerminator()(Code) | | Called when a line terminator has been processed.
|
| processWhiteSpace | | protected void processWhiteSpace()(Code) | | Called when a complete whitespace run has been scanned. pos and endPos
will mark the whitespace boundary.
|
| radix | | public int radix()(Code) | | Return the radix of a numeric literal token.
|
| resetDeprecatedFlag | | public void resetDeprecatedFlag()(Code) | | |
| stringVal | | public String stringVal()(Code) | | The value of a literal token, recorded as a string.
For integers, leading 0x and 'l' suffixes are suppressed.
|
| token | | public Token token()(Code) | | Return the current token, set by nextToken().
|
| token | | public void token(Token token)(Code) | | Sets the current token.
|
|
|