Package com.sun.tools.javac.tree

Class DocTreeMaker

java.lang.Object

com.sun.tools.javac.tree.DocTreeMaker

public class DocTreeMaker
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
int	pos The position at which subsequent trees will be created.
protected static Context.Key<DocTreeMaker>	treeMakerKey The context key for the tree factory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocTreeMaker(Context context) Create a tree maker with NOPOS as initial position.

Method Summary

Modifier and Type	Method and Description
DocTreeMaker	at(int pos) Reassign current position.
DocTreeMaker	at(JCDiagnostic.DiagnosticPosition pos) Reassign current position.
DCTree.DCAttribute	Attribute(Name name, AttributeTree.ValueKind vkind, List<DCTree> value)
DCTree.DCAuthor	Author(List<DCTree> name)
DCTree.DCLiteral	Code(DCTree.DCText text)
DCTree.DCComment	Comment(String text)
DCTree.DCDeprecated	Deprecated(List<DCTree> text)
DCTree.DCDocComment	DocComment(Tokens.Comment comment, List<DCTree> firstSentence, List<DCTree> body, List<DCTree> tags)
DCTree.DCDocRoot	DocRoot()
DCTree.DCEndElement	EndElement(Name name)
DCTree.DCEntity	Entity(Name name)
DCTree.DCErroneous	Erroneous(String text, DiagnosticSource diagSource, String code, Object... args)
DCTree.DCThrows	Exception(DCTree.DCReference name, List<DCTree> description)
DCTree.DCIdentifier	Identifier(Name name)
DCTree.DCInheritDoc	InheritDoc()
static DocTreeMaker	instance(Context context) Get the TreeMaker instance.
DCTree.DCLink	Link(DCTree.DCReference ref, List<DCTree> label)
DCTree.DCLink	LinkPlain(DCTree.DCReference ref, List<DCTree> label)
DCTree.DCLiteral	Literal(DCTree.DCText text)
DCTree.DCParam	Param(boolean isTypeParameter, DCTree.DCIdentifier name, List<DCTree> description)
DCTree.DCReference	Reference(String signature, JCTree qualExpr, Name member, List<JCTree> paramTypes)
DCTree.DCReturn	Return(List<DCTree> description)
DCTree.DCSee	See(List<DCTree> reference)
DCTree.DCSerial	Serial(List<DCTree> description)
DCTree.DCSerialData	SerialData(List<DCTree> description)
DCTree.DCSerialField	SerialField(DCTree.DCIdentifier name, DCTree.DCReference type, List<DCTree> description)
DCTree.DCSince	Since(List<DCTree> text)
DCTree.DCStartElement	StartElement(Name name, List<DCTree> attrs, boolean selfClosing)
DCTree.DCText	Text(String text)
DCTree.DCThrows	Throws(DCTree.DCReference name, List<DCTree> description)
DCTree.DCUnknownBlockTag	UnknownBlockTag(Name name, List<DCTree> content)
DCTree.DCUnknownInlineTag	UnknownInlineTag(Name name, List<DCTree> content)
DCTree.DCValue	Value(DCTree.DCReference ref)
DCTree.DCVersion	Version(List<DCTree> text)

Methods inherited from class java.lang.Object

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

Field Detail

treeMakerKey

protected static final Context.Key<DocTreeMaker> treeMakerKey

The context key for the tree factory.

pos

public int pos

The position at which subsequent trees will be created.

Constructor Detail

DocTreeMaker

protected DocTreeMaker(Context context)

Create a tree maker with NOPOS as initial position.

Method Detail

instance

public static DocTreeMaker instance(Context context)

Get the TreeMaker instance.

at

public DocTreeMaker at(int pos)

Reassign current position.

at

public DocTreeMaker at(JCDiagnostic.DiagnosticPosition pos)

Reassign current position.

Attribute

public DCTree.DCAttribute Attribute(Name name,
                                    AttributeTree.ValueKind vkind,
                                    List<DCTree> value)

Author

public DCTree.DCAuthor Author(List<DCTree> name)

Code

public DCTree.DCLiteral Code(DCTree.DCText text)

Comment

public DCTree.DCComment Comment(String text)

Deprecated

public DCTree.DCDeprecated Deprecated(List<DCTree> text)

DocComment

public DCTree.DCDocComment DocComment(Tokens.Comment comment,
                                      List<DCTree> firstSentence,
                                      List<DCTree> body,
                                      List<DCTree> tags)

DocRoot

public DCTree.DCDocRoot DocRoot()

EndElement

public DCTree.DCEndElement EndElement(Name name)

Entity

public DCTree.DCEntity Entity(Name name)

Erroneous

public DCTree.DCErroneous Erroneous(String text,
                                    DiagnosticSource diagSource,
                                    String code,
                                    Object... args)

Exception

public DCTree.DCThrows Exception(DCTree.DCReference name,
                                 List<DCTree> description)

Identifier

public DCTree.DCIdentifier Identifier(Name name)

InheritDoc

public DCTree.DCInheritDoc InheritDoc()

Link

public DCTree.DCLink Link(DCTree.DCReference ref,
                          List<DCTree> label)

LinkPlain

public DCTree.DCLink LinkPlain(DCTree.DCReference ref,
                               List<DCTree> label)

Literal

public DCTree.DCLiteral Literal(DCTree.DCText text)

Param

public DCTree.DCParam Param(boolean isTypeParameter,
                            DCTree.DCIdentifier name,
                            List<DCTree> description)

Reference

public DCTree.DCReference Reference(String signature,
                                    JCTree qualExpr,
                                    Name member,
                                    List<JCTree> paramTypes)

Return

public DCTree.DCReturn Return(List<DCTree> description)

See

public DCTree.DCSee See(List<DCTree> reference)

Serial

public DCTree.DCSerial Serial(List<DCTree> description)

SerialData

public DCTree.DCSerialData SerialData(List<DCTree> description)

SerialField

public DCTree.DCSerialField SerialField(DCTree.DCIdentifier name,
                                        DCTree.DCReference type,
                                        List<DCTree> description)

Since

public DCTree.DCSince Since(List<DCTree> text)

StartElement

public DCTree.DCStartElement StartElement(Name name,
                                          List<DCTree> attrs,
                                          boolean selfClosing)

Text

public DCTree.DCText Text(String text)

Throws

public DCTree.DCThrows Throws(DCTree.DCReference name,
                              List<DCTree> description)

UnknownBlockTag

public DCTree.DCUnknownBlockTag UnknownBlockTag(Name name,
                                                List<DCTree> content)

UnknownInlineTag

public DCTree.DCUnknownInlineTag UnknownInlineTag(Name name,
                                                  List<DCTree> content)

Value

public DCTree.DCValue Value(DCTree.DCReference ref)

Version

public DCTree.DCVersion Version(List<DCTree> text)