src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/MethodBuilder.java
Print this page
*** 1,7 ****
/*
! * Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
--- 1,7 ----
/*
! * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
*** 21,38 ****
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
! package com.sun.tools.doclets.internal.toolkit.builders;
import java.util.*;
! import com.sun.javadoc.*;
! import com.sun.tools.doclets.internal.toolkit.*;
! import com.sun.tools.doclets.internal.toolkit.util.*;
/**
* Builds documentation for a method.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
--- 21,47 ----
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
! package jdk.javadoc.internal.doclets.toolkit.builders;
import java.util.*;
! import javax.lang.model.element.Element;
! import javax.lang.model.element.ExecutableElement;
! import javax.lang.model.element.TypeElement;
! import javax.lang.model.type.TypeMirror;
+ import jdk.javadoc.internal.doclets.formats.html.ConfigurationImpl;
+ import jdk.javadoc.internal.doclets.toolkit.Configuration;
+ import jdk.javadoc.internal.doclets.toolkit.Content;
+ import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
+ import jdk.javadoc.internal.doclets.toolkit.util.DocFinder;
+ import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberMap;
+
+
/**
* Builds documentation for a method.
*
* <p><b>This is NOT part of any supported API.
* If you write code that depends on this, you do so at your own risk.
*** 47,62 ****
/**
* The index of the current field that is being documented at this point
* in time.
*/
! private int currentMethodIndex;
/**
* The class whose methods are being documented.
*/
! private final ClassDoc classDoc;
/**
* The visible methods for the given class.
*/
private final VisibleMemberMap visibleMemberMap;
--- 56,71 ----
/**
* The index of the current field that is being documented at this point
* in time.
*/
! private ExecutableElement currentMethod;
/**
* The class whose methods are being documented.
*/
! private final TypeElement typeElement;
/**
* The visible methods for the given class.
*/
private final VisibleMemberMap visibleMemberMap;
*** 67,134 ****
private final MethodWriter writer;
/**
* The methods being documented.
*/
! private List<ProgramElementDoc> methods;
/**
* Construct a new MethodBuilder.
*
* @param context the build context.
! * @param classDoc the class whoses members are being documented.
* @param writer the doclet specific writer.
*/
private MethodBuilder(Context context,
! ClassDoc classDoc,
MethodWriter writer) {
super(context);
! this.classDoc = classDoc;
this.writer = writer;
visibleMemberMap = new VisibleMemberMap(
! classDoc,
! VisibleMemberMap.METHODS,
configuration);
! methods =
! new ArrayList<>(visibleMemberMap.getLeafClassMembers(configuration));
! if (configuration.getMemberComparator() != null) {
! Collections.sort(methods, configuration.getMemberComparator());
}
- }
/**
* Construct a new MethodBuilder.
*
* @param context the build context.
! * @param classDoc the class whoses members are being documented.
* @param writer the doclet specific writer.
*
* @return an instance of a MethodBuilder.
*/
public static MethodBuilder getInstance(Context context,
! ClassDoc classDoc, MethodWriter writer) {
! return new MethodBuilder(context, classDoc, writer);
}
/**
* {@inheritDoc}
*/
public String getName() {
return "MethodDetails";
}
/**
* Returns a list of methods that will be documented for the given class.
* This information can be used for doclet specific documentation
* generation.
*
! * @param classDoc the {@link ClassDoc} we want to check.
* @return a list of methods that will be documented.
*/
! public List<ProgramElementDoc> members(ClassDoc classDoc) {
! return visibleMemberMap.getMembersFor(classDoc);
}
/**
* Returns the visible member map for the methods of this class.
*
--- 76,140 ----
private final MethodWriter writer;
/**
* The methods being documented.
*/
! private final SortedSet<Element> methods;
/**
* Construct a new MethodBuilder.
*
* @param context the build context.
! * @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
*/
private MethodBuilder(Context context,
! TypeElement typeElement,
MethodWriter writer) {
super(context);
! this.typeElement = typeElement;
this.writer = writer;
visibleMemberMap = new VisibleMemberMap(
! typeElement,
! VisibleMemberMap.Kind.METHODS,
configuration);
! methods = visibleMemberMap.getLeafClassMembers();
}
/**
* Construct a new MethodBuilder.
*
* @param context the build context.
! * @param typeElement the class whoses members are being documented.
* @param writer the doclet specific writer.
*
* @return an instance of a MethodBuilder.
*/
public static MethodBuilder getInstance(Context context,
! TypeElement typeElement, MethodWriter writer) {
! return new MethodBuilder(context, typeElement, writer);
}
/**
* {@inheritDoc}
*/
+ @Override
public String getName() {
return "MethodDetails";
}
/**
* Returns a list of methods that will be documented for the given class.
* This information can be used for doclet specific documentation
* generation.
*
! * @param typeElement the {@link TypeElement} we want to check.
* @return a list of methods that will be documented.
*/
! public SortedSet<Element> members(TypeElement typeElement) {
! return visibleMemberMap.getMembersFor(typeElement);
}
/**
* Returns the visible member map for the methods of this class.
*
*** 139,150 ****
}
/**
* {@inheritDoc}
*/
public boolean hasMembersToDocument() {
! return methods.size() > 0;
}
/**
* Build the method documentation.
*
--- 145,157 ----
}
/**
* {@inheritDoc}
*/
+ @Override
public boolean hasMembersToDocument() {
! return !methods.isEmpty();
}
/**
* Build the method documentation.
*
*** 153,177 ****
*/
public void buildMethodDoc(XMLNode node, Content memberDetailsTree) {
if (writer == null) {
return;
}
! int size = methods.size();
! if (size > 0) {
! Content methodDetailsTree = writer.getMethodDetailsTreeHeader(
! classDoc, memberDetailsTree);
! for (currentMethodIndex = 0; currentMethodIndex < size;
! currentMethodIndex++) {
! Content methodDocTree = writer.getMethodDocTreeHeader(
! (MethodDoc) methods.get(currentMethodIndex),
! methodDetailsTree);
buildChildren(node, methodDocTree);
methodDetailsTree.addContent(writer.getMethodDoc(
! methodDocTree, (currentMethodIndex == size - 1)));
}
! memberDetailsTree.addContent(
! writer.getMethodDetails(methodDetailsTree));
}
}
/**
* Build the signature.
--- 160,183 ----
*/
public void buildMethodDoc(XMLNode node, Content memberDetailsTree) {
if (writer == null) {
return;
}
! if (!methods.isEmpty()) {
! Content methodDetailsTree = writer.getMethodDetailsTreeHeader(typeElement,
! memberDetailsTree);
! Set<Element> methodDetailSet = ((ConfigurationImpl)configuration).sortedMethodDetails
! ? methods
! : visibleMemberMap.getLeafClassMembersSourceOrder();
! for (Element e : methodDetailSet) {
! currentMethod = (ExecutableElement) e;
! Content methodDocTree = writer.getMethodDocTreeHeader(currentMethod, methodDetailsTree);
buildChildren(node, methodDocTree);
methodDetailsTree.addContent(writer.getMethodDoc(
! methodDocTree, currentMethod == methods.last()));
}
! memberDetailsTree.addContent(writer.getMethodDetails(methodDetailsTree));
}
}
/**
* Build the signature.
*** 178,200 ****
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildSignature(XMLNode node, Content methodDocTree) {
! methodDocTree.addContent(
! writer.getSignature((MethodDoc) methods.get(currentMethodIndex)));
}
/**
* Build the deprecation information.
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildDeprecationInfo(XMLNode node, Content methodDocTree) {
! writer.addDeprecated(
! (MethodDoc) methods.get(currentMethodIndex), methodDocTree);
}
/**
* Build the comments for the method. Do nothing if
* {@link Configuration#nocomment} is set to true.
--- 184,204 ----
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildSignature(XMLNode node, Content methodDocTree) {
! methodDocTree.addContent(writer.getSignature(currentMethod));
}
/**
* Build the deprecation information.
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildDeprecationInfo(XMLNode node, Content methodDocTree) {
! writer.addDeprecated(currentMethod, methodDocTree);
}
/**
* Build the comments for the method. Do nothing if
* {@link Configuration#nocomment} is set to true.
*** 202,223 ****
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildMethodComments(XMLNode node, Content methodDocTree) {
if (!configuration.nocomment) {
! MethodDoc method = (MethodDoc) methods.get(currentMethodIndex);
!
! if (method.inlineTags().length == 0) {
DocFinder.Output docs = DocFinder.search(configuration,
! new DocFinder.Input(method));
! method = docs.inlineTags != null && docs.inlineTags.length > 0 ?
! (MethodDoc) docs.holder : method;
}
! //NOTE: When we fix the bug where ClassDoc.interfaceTypes() does
! // not pass all implemented interfaces, holder will be the
! // interface type. For now, it is really the erasure.
! writer.addComments(method.containingClass(), method, methodDocTree);
}
}
/**
* Build the tag information.
--- 206,224 ----
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildMethodComments(XMLNode node, Content methodDocTree) {
if (!configuration.nocomment) {
! ExecutableElement method = currentMethod;
! if (utils.getBody(currentMethod).isEmpty()) {
DocFinder.Output docs = DocFinder.search(configuration,
! new DocFinder.Input(utils, currentMethod));
! if (docs.inlineTags != null && !docs.inlineTags.isEmpty())
! method = (ExecutableElement)docs.holder;
}
! TypeMirror containingType = method.getEnclosingElement().asType();
! writer.addComments(containingType, method, methodDocTree);
}
}
/**
* Build the tag information.
*** 224,235 ****
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildTagInfo(XMLNode node, Content methodDocTree) {
! writer.addTags((MethodDoc) methods.get(currentMethodIndex),
! methodDocTree);
}
/**
* Return the method writer for this builder.
*
--- 225,235 ----
*
* @param node the XML element that specifies which components to document
* @param methodDocTree the content tree to which the documentation will be added
*/
public void buildTagInfo(XMLNode node, Content methodDocTree) {
! writer.addTags(currentMethod, methodDocTree);
}
/**
* Return the method writer for this builder.
*