Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse CommentHelper

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.util.CommentHelper

public class CommentHelper
extends Object

A utility class.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final DocCommentTree	dcTree
final Element	element
final TreePath	path

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CommentHelper(BaseConfiguration configuration, Element element, TreePath path, DocCommentTree dcTree)	Creates a utility class to encapsulate the contextual information for a doc comment tree.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<? extends DocTree>	getBody(DocTree dtree)
List<? extends DocTree>	getDescription(DocTree dtree)
DocTreePath	getDocTreePath(DocTree dtree)
Element	getException(ThrowsTree tt)
List<? extends DocTree>	getFirstSentenceTrees(List<? extends DocTree> body)
IdentifierTree	getName(DocTree dtree)
String	getParameterName(ParamTree p)
List<? extends DocTree>	getReference(DocTree dtree)
TypeElement	getReferencedClass(Element e)
Element	getReferencedElement(DocTree dtree)
String	getReferencedFragment(String signature)
Element	getReferencedMember(DocTree dtree)
Element	getReferencedMember(Element e)
ModuleElement	getReferencedModule(Element e)
String	getReferencedModuleName(String signature)
PackageElement	getReferencedPackage(Element e)
String	getReferencedSignature(DocTree dtree)	Gibt the normalized signature from a ReferenceTree zurück.
TypeMirror	getReferencedType(DocTree dtree)
TypeElement	getServiceType(DocTree dtree)
String	getTagName(DocTree dtree)
List<? extends DocTree>	getTags(DocTree dtree)
ReferenceTree	getType(DocTree dtree)
TypeMirror	getType(ReferenceTree rtree)
String	toString()	For debugging purposes only.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

path

public final TreePath path

dcTree

public final DocCommentTree dcTree

element

public final Element element

Konstruktordetails

CommentHelper

public CommentHelper(BaseConfiguration configuration,
 Element element,
 TreePath path,
 DocCommentTree dcTree)

Creates a utility class to encapsulate the contextual information for a doc comment tree.

Parameter:

configuration - the configuration

element - the element for which this is a doc comment

path - the path for the element

dcTree - the doc comment

Methodendetails

getTagName

public String getTagName(DocTree dtree)

getParameterName

public String getParameterName(ParamTree p)

getType

public TypeMirror getType(ReferenceTree rtree)

getException

public Element getException(ThrowsTree tt)

getDescription

public List<? extends DocTree> getDescription(DocTree dtree)

getReferencedClass

public TypeElement getReferencedClass(Element e)

getReferencedModuleName

public String getReferencedModuleName(String signature)

getReferencedMember

public Element getReferencedMember(DocTree dtree)

getReferencedMember

public Element getReferencedMember(Element e)

getReferencedFragment

public String getReferencedFragment(String signature)

getReferencedPackage

public PackageElement getReferencedPackage(Element e)

getReferencedModule

public ModuleElement getReferencedModule(Element e)

getFirstSentenceTrees

public List<? extends DocTree> getFirstSentenceTrees(List<? extends DocTree> body)

getReferencedElement

public Element getReferencedElement(DocTree dtree)

getReferencedType

public TypeMirror getReferencedType(DocTree dtree)

getServiceType

public TypeElement getServiceType(DocTree dtree)

getReferencedSignature

public String getReferencedSignature(DocTree dtree)

Gibt the normalized signature from a ReferenceTree zurück.

Gibt zurück:

the normalized signature from a ReferenceTree

getReference

public List<? extends DocTree> getReference(DocTree dtree)

getName

public IdentifierTree getName(DocTree dtree)

getTags

public List<? extends DocTree> getTags(DocTree dtree)

getBody

public List<? extends DocTree> getBody(DocTree dtree)

getType

public ReferenceTree getType(DocTree dtree)

getDocTreePath

public DocTreePath getDocTreePath(DocTree dtree)

toString

public String toString()

For debugging purposes only.

Do not rely on this for other things.

Setzt außer Kraft:

toString in Klasse Object

Gibt zurück:

a string representation.