You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
90 lines
2.5 KiB
90 lines
2.5 KiB
/*
|
|
* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
|
|
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*/
|
|
|
|
package com.sun.source.util;
|
|
|
|
import javax.annotation.processing.ProcessingEnvironment;
|
|
import javax.lang.model.element.Element;
|
|
import javax.tools.JavaCompiler.CompilationTask;
|
|
|
|
import com.sun.source.doctree.DocCommentTree;
|
|
import javax.tools.Diagnostic;
|
|
|
|
/**
|
|
* Provides access to syntax trees for doc comments.
|
|
*
|
|
* @since 1.8
|
|
*/
|
|
@jdk.Exported
|
|
public abstract class DocTrees extends Trees {
|
|
/**
|
|
* Gets a DocTrees object for a given CompilationTask.
|
|
* @param task the compilation task for which to get the Trees object
|
|
* @throws IllegalArgumentException if the task does not support the Trees API.
|
|
*/
|
|
public static DocTrees instance(CompilationTask task) {
|
|
return (DocTrees) Trees.instance(task);
|
|
}
|
|
|
|
/**
|
|
* Gets a DocTrees object for a given ProcessingEnvironment.
|
|
* @param env the processing environment for which to get the Trees object
|
|
* @throws IllegalArgumentException if the env does not support the Trees API.
|
|
*/
|
|
public static DocTrees instance(ProcessingEnvironment env) {
|
|
if (!env.getClass().getName().equals("com.sun.tools.javac.processing.JavacProcessingEnvironment"))
|
|
throw new IllegalArgumentException();
|
|
return (DocTrees) getJavacTrees(ProcessingEnvironment.class, env);
|
|
}
|
|
|
|
/**
|
|
* Gets the doc comment tree, if any, for the Tree node identified by a given TreePath.
|
|
* Returns null if no doc comment was found.
|
|
*/
|
|
public abstract DocCommentTree getDocCommentTree(TreePath path);
|
|
|
|
/**
|
|
* Gets the language model element referred to by the leaf node of the given
|
|
* {@link DocTreePath}, or null if unknown.
|
|
*/
|
|
public abstract Element getElement(DocTreePath path);
|
|
|
|
public abstract DocSourcePositions getSourcePositions();
|
|
|
|
/**
|
|
* Prints a message of the specified kind at the location of the
|
|
* tree within the provided compilation unit
|
|
*
|
|
* @param kind the kind of message
|
|
* @param msg the message, or an empty string if none
|
|
* @param t the tree to use as a position hint
|
|
* @param root the compilation unit that contains tree
|
|
*/
|
|
public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg,
|
|
com.sun.source.doctree.DocTree t,
|
|
com.sun.source.doctree.DocCommentTree c,
|
|
com.sun.source.tree.CompilationUnitTree root);
|
|
}
|