Package org.jdrupes.mdoclet

Klasse DocTreesWrapper

java.lang.Object

com.sun.source.util.Trees

com.sun.source.util.DocTrees

org.jdrupes.mdoclet.DocTreesWrapper

public class DocTreesWrapper
extends DocTrees

Wraps the DocTrees passed to the constructor.

The main purpose of the wrapper is to wrap the results from methods that return a DocCommentTree for already parsed content in a DocCommentTreeWrapper.

For method invocations with FileObjects as argument, the source is converted from markdown to html if the name ends with “.md”.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DocTreesWrapper(MDoclet doclet, MDocletEnvironment environment, DocTrees docTrees)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
BreakIterator	getBreakIterator()	Delegates to the docTrees passed to the constructor.
String	getCharacters(EntityTree tree)	Delegates to the docTrees passed to the constructor.
String	getDocComment(TreePath path)	Delegates to the docTrees passed to the constructor.
DocCommentTree	getDocCommentTree(TreePath path)	Substitutes the original doctree with one processed my the markdown processor.
DocCommentTree	getDocCommentTree(Element e)	Delegates to the docTrees passed to the constructor.
DocCommentTree	getDocCommentTree(Element e, String relativePath)	Delegates to the docTrees passed to the constructor.
DocCommentTree	getDocCommentTree(FileObject fileObject)	Delegates to the docTrees passed to the constructor.
DocTreeFactory	getDocTreeFactory()	Delegates to the docTrees passed to the constructor.
DocTreePath	getDocTreePath(FileObject fileObject, PackageElement packageElement)	Delegates to the docTrees passed to the constructor.
Element	getElement(DocTreePath path)	Delegates to the docTrees passed to the constructor.
Element	getElement(TreePath path)	Delegates to the docTrees passed to the constructor.
List<DocTree>	getFirstSentence(List<? extends DocTree> list)	Delegates to the docTrees passed to the constructor.
TypeMirror	getLub(CatchTree tree)	Delegates to the docTrees passed to the constructor.
TypeMirror	getOriginalType(ErrorType errorType)	Delegates to the docTrees passed to the constructor.
TreePath	getPath(CompilationUnitTree unit, Tree node)	Delegates to the docTrees passed to the constructor.
TreePath	getPath(Element e)	Delegates to the docTrees passed to the constructor.
TreePath	getPath(Element e, AnnotationMirror a)	Delegates to the docTrees passed to the constructor.
TreePath	getPath(Element e, AnnotationMirror a, AnnotationValue v)	Delegates to the docTrees passed to the constructor.
Scope	getScope(TreePath path)	Delegates to the docTrees passed to the constructor.
DocSourcePositions	getSourcePositions()	Delegates to the docTrees passed to the constructor.
Tree	getTree(Element element)	Delegates to the docTrees passed to the constructor.
Tree	getTree(Element e, AnnotationMirror a)	Delegates to the docTrees passed to the constructor.
Tree	getTree(Element e, AnnotationMirror a, AnnotationValue v)	Delegates to the docTrees passed to the constructor.
MethodTree	getTree(ExecutableElement method)	Delegates to the docTrees passed to the constructor.
ClassTree	getTree(TypeElement element)	Delegates to the docTrees passed to the constructor.
TypeMirror	getType(DocTreePath path)	Delegates to the docTrees passed to the constructor.
TypeMirror	getTypeMirror(TreePath path)	Delegates to the docTrees passed to the constructor.
boolean	isAccessible(Scope scope, Element member, DeclaredType type)	Delegates to the docTrees passed to the constructor.
boolean	isAccessible(Scope scope, TypeElement type)	Delegates to the docTrees passed to the constructor.
void	printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)	Delegates to the docTrees passed to the constructor.
void	printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root)	Delegates to the docTrees passed to the constructor.
void	setBreakIterator(BreakIterator breakiterator)	Delegates to the docTrees passed to the constructor.
String	toString()	Delegates to the docTrees passed to the constructor.

Von Klasse geerbte Methoden com.sun.source.util.DocTrees

instance, instance

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DocTreesWrapper

public DocTreesWrapper(MDoclet doclet,
 MDocletEnvironment environment,
 DocTrees docTrees)

Methodendetails

getBreakIterator

public BreakIterator getBreakIterator()

Delegates to the docTrees passed to the constructor.

Angegeben von:

getBreakIterator in Klasse DocTrees

Siehe auch:

• DocTrees.getBreakIterator()

getDocCommentTree

public DocCommentTree getDocCommentTree(TreePath path)

Substitutes the original doctree with one processed my the markdown processor.

Angegeben von:

getDocCommentTree in Klasse DocTrees

Siehe auch:

• DocTrees.getDocCommentTree(com.sun.source.util.TreePath)

getDocCommentTree

public DocCommentTree getDocCommentTree(Element e)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocCommentTree in Klasse DocTrees

Siehe auch:

• DocTrees.getDocCommentTree(javax.lang.model.element.Element)

getDocCommentTree

public DocCommentTree getDocCommentTree(FileObject fileObject)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocCommentTree in Klasse DocTrees

Siehe auch:

• DocTrees.getDocCommentTree(javax.tools.FileObject)

getTree

public Tree getTree(Element element)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTree in Klasse Trees

Siehe auch:

• Trees.getTree(javax.lang.model.element.Element)

getDocCommentTree

public DocCommentTree getDocCommentTree(Element e,
 String relativePath)
                                 throws IOException

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocCommentTree in Klasse DocTrees

Löst aus:

IOException

Siehe auch:

• DocTrees.getDocCommentTree(javax.lang.model.element.Element, java.lang.String)

getTree

public ClassTree getTree(TypeElement element)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTree in Klasse Trees

Siehe auch:

• Trees.getTree(javax.lang.model.element.TypeElement)

getTree

public MethodTree getTree(ExecutableElement method)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTree in Klasse Trees

Siehe auch:

• Trees.getTree(javax.lang.model.element.ExecutableElement)

getTree

public Tree getTree(Element e,
 AnnotationMirror a)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTree in Klasse Trees

Siehe auch:

• Trees.getTree(javax.lang.model.element.Element, javax.lang.model.element.AnnotationMirror)

getDocTreePath

public DocTreePath getDocTreePath(FileObject fileObject,
 PackageElement packageElement)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocTreePath in Klasse DocTrees

Siehe auch:

• DocTrees.getDocTreePath(javax.tools.FileObject, javax.lang.model.element.PackageElement)

getTree

public Tree getTree(Element e,
 AnnotationMirror a,
 AnnotationValue v)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTree in Klasse Trees

Siehe auch:

• Trees.getTree(javax.lang.model.element.Element, javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationValue)

getPath

public TreePath getPath(CompilationUnitTree unit,
 Tree node)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getPath in Klasse Trees

Siehe auch:

• Trees.getPath(com.sun.source.tree.CompilationUnitTree, com.sun.source.tree.Tree)

getPath

public TreePath getPath(Element e)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getPath in Klasse Trees

Siehe auch:

• Trees.getPath(javax.lang.model.element.Element)

getElement

public Element getElement(DocTreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getElement in Klasse DocTrees

Siehe auch:

• DocTrees.getElement(com.sun.source.util.DocTreePath)

getPath

public TreePath getPath(Element e,
 AnnotationMirror a)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getPath in Klasse Trees

Siehe auch:

• Trees.getPath(javax.lang.model.element.Element, javax.lang.model.element.AnnotationMirror)

getFirstSentence

public List<DocTree> getFirstSentence(List<? extends DocTree> list)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getFirstSentence in Klasse DocTrees

Siehe auch:

• DocTrees.getFirstSentence(java.util.List)

getPath

public TreePath getPath(Element e,
 AnnotationMirror a,
 AnnotationValue v)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getPath in Klasse Trees

Siehe auch:

• Trees.getPath(javax.lang.model.element.Element, javax.lang.model.element.AnnotationMirror, javax.lang.model.element.AnnotationValue)

getSourcePositions

public DocSourcePositions getSourcePositions()

Delegates to the docTrees passed to the constructor.

Angegeben von:

getSourcePositions in Klasse DocTrees

Siehe auch:

• DocTrees.getSourcePositions()

getElement

public Element getElement(TreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getElement in Klasse Trees

Siehe auch:

• Trees.getElement(com.sun.source.util.TreePath)

printMessage

public void printMessage(Diagnostic.Kind kind,
 CharSequence msg,
 DocTree t,
 DocCommentTree c,
 CompilationUnitTree root)

Delegates to the docTrees passed to the constructor.

Angegeben von:

printMessage in Klasse DocTrees

Siehe auch:

• DocTrees.printMessage(javax.tools.Diagnostic.Kind, java.lang.CharSequence, com.sun.source.doctree.DocTree, com.sun.source.doctree.DocCommentTree, com.sun.source.tree.CompilationUnitTree)

getTypeMirror

public TypeMirror getTypeMirror(TreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getTypeMirror in Klasse Trees

Siehe auch:

• Trees.getTypeMirror(com.sun.source.util.TreePath)

setBreakIterator

public void setBreakIterator(BreakIterator breakiterator)

Delegates to the docTrees passed to the constructor.

Angegeben von:

setBreakIterator in Klasse DocTrees

Siehe auch:

• DocTrees.setBreakIterator(java.text.BreakIterator)

getScope

public Scope getScope(TreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getScope in Klasse Trees

Siehe auch:

• Trees.getScope(com.sun.source.util.TreePath)

getDocTreeFactory

public DocTreeFactory getDocTreeFactory()

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocTreeFactory in Klasse DocTrees

Siehe auch:

• DocTrees.getDocTreeFactory()

getDocComment

public String getDocComment(TreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getDocComment in Klasse Trees

Siehe auch:

• Trees.getDocComment(com.sun.source.util.TreePath)

isAccessible

public boolean isAccessible(Scope scope,
 TypeElement type)

Delegates to the docTrees passed to the constructor.

Angegeben von:

isAccessible in Klasse Trees

Siehe auch:

• Trees.isAccessible(com.sun.source.tree.Scope, javax.lang.model.element.TypeElement)

isAccessible

public boolean isAccessible(Scope scope,
 Element member,
 DeclaredType type)

Delegates to the docTrees passed to the constructor.

Angegeben von:

isAccessible in Klasse Trees

Siehe auch:

• Trees.isAccessible(com.sun.source.tree.Scope, javax.lang.model.element.Element, javax.lang.model.type.DeclaredType)

getOriginalType

public TypeMirror getOriginalType(ErrorType errorType)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getOriginalType in Klasse Trees

Siehe auch:

• Trees.getOriginalType(javax.lang.model.type.ErrorType)

printMessage

public void printMessage(Diagnostic.Kind kind,
 CharSequence msg,
 Tree t,
 CompilationUnitTree root)

Delegates to the docTrees passed to the constructor.

Angegeben von:

printMessage in Klasse Trees

Siehe auch:

• Trees.printMessage(javax.tools.Diagnostic.Kind, java.lang.CharSequence, com.sun.source.tree.Tree, com.sun.source.tree.CompilationUnitTree)

getLub

public TypeMirror getLub(CatchTree tree)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getLub in Klasse Trees

Siehe auch:

• Trees.getLub(com.sun.source.tree.CatchTree)

getType

public TypeMirror getType(DocTreePath path)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getType in Klasse DocTrees

getCharacters

public String getCharacters(EntityTree tree)

Delegates to the docTrees passed to the constructor.

Angegeben von:

getCharacters in Klasse DocTrees

toString

public String toString()

Delegates to the docTrees passed to the constructor.

Setzt außer Kraft:

toString in Klasse Object

Siehe auch:

• Object.toString()