|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.javatools.parser.AbstractLexer oracle.javatools.parser.java.v2.scanner.FastLexer oracle.javatools.parser.java.v2.scanner.JavadocLexer
public class JavadocLexer
The JavaDocLexer
is an implementation of the
Lexer
interface for tokenizing a Java language documentation
comment ("doc comment" aka, in violation of copyright, "Javadoc comment").
Lexer
,
JavadocTokens
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.javatools.parser.AbstractLexer |
---|
AbstractLexer.DefaultLexerToken |
Field Summary |
---|
Fields inherited from class oracle.javatools.parser.java.v2.scanner.FastLexer |
---|
skipComments |
Fields inherited from class oracle.javatools.parser.AbstractLexer |
---|
currentPos, textBuffer |
Fields inherited from interface oracle.javatools.parser.java.v2.JavadocTokens |
---|
TAG_AUTHOR, TAG_base, TAG_CODE, TAG_DEPRECATED, TAG_DOCROOT, TAG_EXCEPTION, TAG_HIDDEN, TAG_INHERITDOC, TAG_inline, TAG_LINK, TAG_LINKPLAIN, TAG_LITERAL, TAG_max, TAG_PARAM, TAG_RETURN, TAG_SEE, TAG_SERIAL, TAG_SERIALDATA, TAG_SERIALFIELD, TAG_SINCE, TAG_THROWS, TAG_unknown, TAG_VALUE, TAG_VERSION, TAG_words, TK_DOC_base, TK_DOC_COLON, TK_DOC_COMMA, TK_DOC_DOT, TK_DOC_HASH, TK_DOC_LBRACE, TK_DOC_LINE_START, TK_DOC_LPAREN, TK_DOC_NEWLINE, TK_DOC_RBRACE, TK_DOC_RPAREN, TK_DOC_TEXT, TK_DOC_WHITESPACE |
Fields inherited from interface oracle.javatools.parser.Lexer |
---|
TK_EOF, TK_NOT_FOUND |
Constructor Summary | |
---|---|
JavadocLexer()
Constructs a default JavaDocLexer with a starting
position of 0. |
Method Summary | |
---|---|
void |
backup()
Unlexes the last found token. |
int |
getEndOffset()
Fetches the end offset of the token (offset relative to the original ReadTextBuffer being lexed. |
int |
getStartOffset()
Fetches the start offset of the token (offset relative to the original ReadTextBuffer being lexed. |
int |
getToken()
Fetches the (language-specific) token represented by this LexerToken . |
int |
lex()
Calls lex( LexerToken ) but does not call fillLexerToken. |
int |
lex(LexerToken lexedToken)
Scans the text buffer at the current position and returns the token that was found. |
void |
setPosition(int offset)
Sets the current lex (read) position to the given offset in the buffer. |
Methods inherited from class oracle.javatools.parser.java.v2.scanner.FastLexer |
---|
isComment, setSkipComments |
Methods inherited from class oracle.javatools.parser.AbstractLexer |
---|
createLexerToken, getTextBuffer, setTextBuffer |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JavadocLexer()
JavaDocLexer
with a starting
position of 0. Clients must call setTextBuffer()
to
initialize the text buffer used for the Lexer. To start lexing
from an offset other than 0, call setPosition()
.
Method Detail |
---|
public int getToken()
LexerToken
LexerToken
. You must refer to the language-specific
Lexer that was responsible for filling this
LexerToken
instance to interpret the token.
getToken
in interface LexerToken
getToken
in class FastLexer
public int getStartOffset()
LexerToken
ReadTextBuffer
being lexed. Note that the
start offset is inclusive (compare to end offset which is
exclusive), to match the behavior in the String
class.
getStartOffset
in interface LexerToken
getStartOffset
in class FastLexer
public int getEndOffset()
LexerToken
ReadTextBuffer
being lexed. Note that the end offset is
exclusive (similar to end offsets in the String class.)
getEndOffset
in interface LexerToken
getEndOffset
in class FastLexer
public void backup()
lex()
will return the last token and offset information found.
backup
in interface Lexer
backup
in class FastLexer
public void setPosition(int offset)
setPosition
in interface Lexer
setPosition
in class AbstractLexer
offset
- the offset for the next lex()
operation.public int lex()
FastLexer
lex
in class FastLexer
public int lex(LexerToken lexedToken)
lexedToken
instance passed in to the
call.
lex
in interface Lexer
lex
in class FastLexer
lexedToken
- the instance passed in where token info is stored
lexedToken.getToken()
(for convenience)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |