Java DocTree类代码示例

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
void checkReference(ReferenceTree tree, List<? extends DocTree> label) {
    String sig = tree.getSignature();

    Element found = trees.getElement(new DocTreePath(getCurrentPath(), tree));
    if (found == null) {
        System.err.println(sig + " NOT FOUND");
    } else {
        System.err.println(sig + " found " + found.getKind() + " " + found);
    }

    String expect = "UNKNOWN";
    if (label.size() > 0 && label.get(0) instanceof TextTree)
        expect = ((TextTree) label.get(0)).getBody();

    if (!expect.equalsIgnoreCase(found == null ? "bad" : found.getKind().name())) {
        error(tree, "Unexpected value found: " + found +", expected: " + expect);
    }
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
/**
 * Adds the comment tags.
 *
 * @param element for which the comment tags will be generated
 * @param holderTag the block tag context for the inline tags
 * @param tags the first sentence tags for the doc
 * @param depr true if it is deprecated
 * @param first true if the first sentence tags should be added
 * @param htmltree the documentation tree to which the comment tags will be added
 */
private void addCommentTags(Element element, DocTree holderTag, List<? extends DocTree> tags, boolean depr,
        boolean first, Content htmltree) {
    if(configuration.nocomment){
        return;
    }
    Content div;
    Content result = commentTagsToContent(null, element, tags, first);
    if (depr) {
        Content italic = HtmlTree.SPAN(HtmlStyle.deprecationComment, result);
        div = HtmlTree.DIV(HtmlStyle.block, italic);
        htmltree.addContent(div);
    }
    else {
        div = HtmlTree.DIV(HtmlStyle.block, result);
        htmltree.addContent(div);
    }
    if (tags.isEmpty()) {
        htmltree.addContent(Contents.SPACE);
    }
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
public boolean run(DocletEnvironment root) {
        DocTrees trees = root.getDocTrees();
        TypeElement cd = ElementFilter.typesIn(root.getIncludedElements()).iterator().next();
        DocCommentTree docCommentTree = trees.getDocCommentTree(cd);
        List<? extends DocTree> tags = docCommentTree.getBody();

        for (int i = 0; i < tags.size(); i++) {
            System.out.println(tags.get(0).getKind());
//            if (!tags[i].name().equals(expectedTags[i]) ||
//                        !tags[i].text().equals(expectedText[i])) {
//                throw new Error("Tag \"" + tags[i] + "\" not as expected");
//            }
        }

        return true;
    }
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
/**
 * Given an array of <code>ParamTag</code>s,return its string representation.
 * Try to inherit the param tags that are missing.
 *
 * @param holder            the element that holds the param tags.
 * @param writer            the TagletWriter that will write this tag.
 * @param formalParameters  The array of parmeters (from type or executable
 *                          member) to check.
 *
 * @return the TagletOutput representation of these <code>ParamTag</code>s.
 */
private Content getTagletOutput(boolean isParameters, Element holder,
        TagletWriter writer, List<? extends Element> formalParameters, List<? extends DocTree> paramTags) {
    Content result = writer.getOutputInstance();
    Set<String> alreadyDocumented = new HashSet<>();
    if (!paramTags.isEmpty()) {
        result.addContent(
            processParamTags(holder, isParameters, paramTags,
            getRankMap(writer.configuration().utils, formalParameters), writer, alreadyDocumented)
        );
    }
    if (alreadyDocumented.size() != formalParameters.size()) {
        //Some parameters are missing corresponding @param tags.
        //Try to inherit them.
        result.addContent(getInheritedTagletOutput(isParameters, holder,
            writer, formalParameters, alreadyDocumented));
    }
    return result;
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
@Override
public Iterator<DocTree> iterator() {
    return new Iterator<DocTree>() {
        @Override
        public boolean hasNext() {
            return next != null;
        }

        @Override
        public DocTree next() {
            DocTree t = next.leaf;
            next = next.parent;
            return t;
        }

        @Override
        public void remove() {
            throw new UnsupportedOperationException();
        }

        private DocTreePath next = DocTreePath.this;
    };
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
public static JavaFix createAddParamTagFix(DocTreePathHandle dtph, final String name, final boolean isTypeParam, int index) {
    return new AddTagFix(dtph, isTypeParam? MISSING_TYPEPARAM_HINT("<" + name + ">"):MISSING_PARAM_HINT(name), index) {
        @Override
        protected DocTree getNewTag(TreeMaker make) {
            return make.Param(isTypeParam, make.DocIdentifier(name), Collections.EMPTY_LIST);
        }
    };
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
protected final IndexTree rewriteChildren(IndexTree tree) {
    IndexTree value = tree;
    List<? extends DocTree> desc = translateDoc(tree.getDescription());
    DocTree term = translate(tree.getSearchTerm());
    if (desc != tree.getDescription() || term != tree.getSearchTerm()) {
        value = make.Index(term, desc);
    }
    return value;
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
void warnIfEmpty(DocTree tree, List<? extends DocTree> list) {
//        for (DocTree d: list) {
//            switch (d.getKind()) {
//                case TEXT:
//                    if (hasNonWhitespace((TextTree) d))
//                        return;
//                    break;
//                default:
//                    return;
//            }
//        }
//        env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName);
    }
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
@Override
protected void performRewrite(TransformationContext ctx) throws Exception {
    WorkingCopy javac = ctx.getWorkingCopy();
    DocTreePath path = dtph.resolve(javac);
    DocCommentTree docComment = path.getDocComment();
    TreeMaker make = javac.getTreeMaker();
    TagComparator comparator = new TagComparator();
    final List<DocTree> blockTags = new LinkedList<DocTree>();
    DocTree newTree = getNewTag(make);
    
    boolean added = false;
    int count = 0;
    for (DocTree docTree : docComment.getBlockTags()) {
        if (!added && comparator.compare(newTree, docTree) == TagComparator.HIGHER) {
            blockTags.add(newTree);
            added = true;
        }
        if (!added && comparator.compare(newTree, docTree) == TagComparator.EQUAL &&
                index == count++) {
            blockTags.add(newTree);
            added = true;
        }
        blockTags.add(docTree);
    }
    if (!added) {
        blockTags.add(newTree);
    }
    
    DocCommentTree newDoc = make.DocComment(docComment.getFirstSentence(), docComment.getBody(), blockTags);
    Tree tree = ctx.getPath().getLeaf();
    javac.rewrite(tree, docComment, newDoc);
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
/**
 * Add the description text for this member represented by the tag.
 *
 * @param serialFieldTag the field to document (represented by tag)
 * @param contentTree the tree to which the deprecated info will be added
 */
public void addMemberDescription(VariableElement field, DocTree serialFieldTag, Content contentTree) {
    CommentHelper ch = utils.getCommentHelper(field);
    List<? extends DocTree> description = ch.getDescription(configuration, serialFieldTag);
    if (!description.isEmpty()) {
        Content serialFieldContent = new RawHtml(ch.getText(description));
        Content div = HtmlTree.DIV(HtmlStyle.block, serialFieldContent);
        contentTree.addContent(div);
    }
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
public void setEnumValuesTree(BaseConfiguration config, Element e) {
    Utils utils = config.utils;
    String klassName = utils.getSimpleName(utils.getEnclosingTypeElement(e));

    List<DocTree> fullBody = new ArrayList<>();
    fullBody.add(treeFactory.newTextTree(config.getText("doclet.enum_values_doc.fullbody", klassName)));

    List<DocTree> descriptions = new ArrayList<>();
    descriptions.add(treeFactory.newTextTree(config.getText("doclet.enum_values_doc.return")));

    List<DocTree> tags = new ArrayList<>();
    tags.add(treeFactory.newReturnTree(descriptions));
    DocCommentTree docTree = treeFactory.newDocCommentTree(fullBody, tags);
    dcTreesMap.put(e, new DocCommentDuo(null, docTree));
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
private boolean isSentenceBreak(DocTree dt, boolean isFirstDocTree) {
    switch (dt.getKind()) {
        case START_ELEMENT:
                StartElementTree set = (StartElementTree)dt;
                return !isFirstDocTree && ((DCTree) dt).pos > 1 && isSentenceBreak(set.getName());
        case END_ELEMENT:
                EndElementTree eet = (EndElementTree)dt;
                return !isFirstDocTree && ((DCTree) dt).pos > 1 && isSentenceBreak(eet.getName());
        default:
            return false;
    }
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
@Override
public Void visitSee(SeeTree tree, Void ignore) {
    List<? extends DocTree> refLabel = tree.getReference();
    if (refLabel.size() > 1 && (refLabel.get(0) instanceof ReferenceTree)) {
        ReferenceTree ref = (ReferenceTree) refLabel.get(0);
        List<? extends DocTree> label = refLabel.subList(1, refLabel.size());
        checkReference(ref, label);
    }
    return null;
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
void warnIfEmpty(DocTree tree, List<? extends DocTree> list) {
    for (DocTree d: list) {
        switch (d.getKind()) {
            case TEXT:
                if (hasNonWhitespace((TextTree) d))
                    return;
                break;
            default:
                return;
        }
    }
    env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName);
}
 

import com.sun.source.doctree.DocTree; //导入依赖的package包/类
@Override
public Void visitDocComment(DocCommentTree tree, Void ignore) {
    super.visitDocComment(tree, ignore);
    for (TagStackItem tsi: tagStack) {
        warnIfEmpty(tsi, null);
        if (tsi.tree.getKind() == DocTree.Kind.START_ELEMENT
                && tsi.tag.endKind == HtmlTag.EndKind.REQUIRED) {
            StartElementTree t = (StartElementTree) tsi.tree;
            env.messages.error(HTML, t, "dc.tag.not.closed", t.getName());
        }
    }
    return null;
}