Package com.sun.tools.javac.parser

Class DocCommentParser

java.lang.Object

com.sun.tools.javac.parser.DocCommentParser

public class DocCommentParser
extends Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	bp
protected char[]	buf The input buffer, index of most recent character read, index of one past last character in buffer.
protected int	buflen
protected char	ch The current character.

Method Summary

Modifier and Type	Method and Description
protected void	addPendingText(ListBuffer<DCTree> list, int textEnd)
protected void	attrValueChar(ListBuffer<DCTree> list)
protected List<DCTree>	blockContent() Read block content, consisting of text, html and inline tags.
protected DCTree	blockTag() Read a single block tag, including its content.
protected List<DCTree>	blockTags() Read a series of block tags, including their content.
protected DCTree	entity() Read an HTML entity.
protected void	entity(ListBuffer<DCTree> list)
protected DCTree.DCErroneous	erroneous(String code, int pos)
protected int	getSentenceBreak(String s)
protected DCTree	html() Read the start or end of an HTML tag, or an HTML comment <identifier attrs> or </identifier>
protected List<DCTree>	htmlAttrs() Read a series of HTML attributes, terminated by > .
protected DCTree.DCIdentifier	identifier() Read Java identifier Matching pairs of { } are skipped; the text is terminated by the first unmatched }.
protected List<DCTree>	inlineContent() Read general text content of an inline tag, including HTML entities and elements.
protected DCTree	inlineTag() Read a single inline tag, including its content.
protected void	inlineTag(ListBuffer<DCTree> list)
protected DCTree	inlineText() Read plain text content of an inline tag.
protected boolean	isDecimalDigit(char ch)
protected boolean	isHexDigit(char ch)
protected boolean	isIdentifierStart(char ch)
protected boolean	isJavaIdentifierStart(char ch)
protected boolean	isSentenceBreak(DCTree t)
protected boolean	isSentenceBreak(Name n)
protected boolean	isUnquotedAttrValueTerminator(char ch)
protected boolean	isWhitespace(char ch)
protected DCTree.DCText	quotedString() Read a quoted string.
protected Name	readIdentifier()
protected Name	readJavaIdentifier()
protected Name	readTagName()
protected DCTree.DCReference	reference(boolean allowMember) Read Java class name, possibly followed by member Matching pairs of < > are skipped.
protected void	skipWhitespace()

Methods inherited from class java.lang.Object

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

Field Detail

buf

protected char[] buf

The input buffer, index of most recent character read, index of one past last character in buffer.

bp

protected int bp

buflen

protected int buflen

ch

protected char ch

The current character.

Method Detail

blockContent

protected List<DCTree> blockContent()

Read block content, consisting of text, html and inline tags. Terminated by the end of input, or the beginning of the next block tag: i.e. @ as the first non-whitespace character on a line.

blockTags

protected List<DCTree> blockTags()

Read a series of block tags, including their content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag.

blockTag

protected DCTree blockTag()

Read a single block tag, including its content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag.

inlineTag

protected void inlineTag(ListBuffer<DCTree> list)

inlineTag

protected DCTree inlineTag()

Read a single inline tag, including its content. Standard tags parse their content appropriately. Non-standard tags are represented by UnknownBlockTag. Malformed tags may be returned as Erroneous.

inlineText

protected DCTree inlineText()
                     throws com.sun.tools.javac.parser.DocCommentParser.ParseException

Read plain text content of an inline tag. Matching pairs of { } are skipped; the text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.

Throws:

com.sun.tools.javac.parser.DocCommentParser.ParseException

reference

protected DCTree.DCReference reference(boolean allowMember)
                                throws com.sun.tools.javac.parser.DocCommentParser.ParseException

Read Java class name, possibly followed by member Matching pairs of < > are skipped. The text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.

Throws:

com.sun.tools.javac.parser.DocCommentParser.ParseException

identifier

protected DCTree.DCIdentifier identifier()
                                  throws com.sun.tools.javac.parser.DocCommentParser.ParseException

Read Java identifier Matching pairs of { } are skipped; the text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.

Throws:

com.sun.tools.javac.parser.DocCommentParser.ParseException

quotedString

protected DCTree.DCText quotedString()

Read a quoted string. It is an error if the beginning of the next tag is detected.

inlineContent

protected List<DCTree> inlineContent()

Read general text content of an inline tag, including HTML entities and elements. Matching pairs of { } are skipped; the text is terminated by the first unmatched }. It is an error if the beginning of the next tag is detected.

entity

protected void entity(ListBuffer<DCTree> list)

entity

protected DCTree entity()

Read an HTML entity. &identifier; or &#digits; or &#xhex-digits;

html

protected DCTree html()

Read the start or end of an HTML tag, or an HTML comment <identifier attrs> or </identifier>

htmlAttrs

protected List<DCTree> htmlAttrs()

Read a series of HTML attributes, terminated by > . Each attribute is of the form identifier[=value] . "value" may be unquoted, single-quoted, or double-quoted.

attrValueChar

protected void attrValueChar(ListBuffer<DCTree> list)

addPendingText

protected void addPendingText(ListBuffer<DCTree> list,
                              int textEnd)

erroneous

protected DCTree.DCErroneous erroneous(String code,
                                       int pos)

isIdentifierStart

protected boolean isIdentifierStart(char ch)

readIdentifier

protected Name readIdentifier()

readTagName

protected Name readTagName()

isJavaIdentifierStart

protected boolean isJavaIdentifierStart(char ch)

readJavaIdentifier

protected Name readJavaIdentifier()

isDecimalDigit

protected boolean isDecimalDigit(char ch)

isHexDigit

protected boolean isHexDigit(char ch)

isUnquotedAttrValueTerminator

protected boolean isUnquotedAttrValueTerminator(char ch)

isWhitespace

protected boolean isWhitespace(char ch)

skipWhitespace

protected void skipWhitespace()

getSentenceBreak

protected int getSentenceBreak(String s)

isSentenceBreak

protected boolean isSentenceBreak(Name n)

isSentenceBreak

protected boolean isSentenceBreak(DCTree t)