jdk-sandbox: comparison langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractBuilder.java

equal deleted inserted replaced

-:e17429a7e843
+:1c355ea550ed
 * questions.
 */
 package jdk.javadoc.internal.doclets.toolkit.builders;
-import java.io.*;
 import java.lang.reflect.*;
 import java.util.*;
 import javax.lang.model.element.PackageElement;
 import jdk.javadoc.internal.doclets.toolkit.Configuration;
 import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
 import jdk.javadoc.internal.doclets.toolkit.Messages;
-import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;
+import jdk.javadoc.internal.doclets.toolkit.Resources;
+import jdk.javadoc.internal.doclets.toolkit.util.InternalException;
+import jdk.javadoc.internal.doclets.toolkit.util.SimpleDocletException;
 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
 import static javax.tools.Diagnostic.Kind.*;
 /**
 * The configuration used in this run of the doclet.
 */
 protected final Configuration configuration;
 protected final Messages messages;
+protected final Resources resources;
 protected final Utils utils;
 /**
 * Keep track of which packages we have seen for
 * efficiency purposes.  We don't want to copy the
 */
 protected static final boolean DEBUG = false;
 /**
 * Construct a Builder.
-* @param configuration the configuration used in this run
+* @param c a context providing information used in this run of the doclet
-*        of the doclet.
 */
 public AbstractBuilder(Context c) {
 this.configuration = c.configuration;
 this.messages = configuration.getMessages();
+this.resources = configuration.getResources();
 this.utils = configuration.utils;
 this.containingPackagesSeen = c.containingPackagesSeen;
 this.layoutParser = c.layoutParser;
 }
 public abstract String getName();
 /**
 * Build the documentation.
 *
-* @throws IOException there was a problem writing the output.
+* @throws DocletException if there is a problem building the documentation
 */
-public abstract void build() throws IOException;
+public abstract void build() throws DocletException;
 /**
 * Build the documentation, as specified by the given XML element.
 *
 * @param node the XML element that specifies which component to document.
 * @param contentTree content tree to which the documentation will be added
+* @throws DocletException if there is a problem building the documentation
 */
-protected void build(XMLNode node, Content contentTree) {
+protected void build(XMLNode node, Content contentTree) throws DocletException {
 String component = node.name;
 try {
-invokeMethod("build" + component,
+String methodName = "build" + component;
-new Class<?>[]{XMLNode.class, Content.class},
+if (DEBUG) {
-new Object[]{node, contentTree});
+configuration.reporter.print(ERROR,
+"DEBUG: " + getClass().getName() + "." + methodName);
+}
+Method method = getClass().getMethod(methodName, XMLNode.class, Content.class);
+method.invoke(this, node, contentTree);
 } catch (NoSuchMethodException e) {
-e.printStackTrace(System.err);
+// Use SimpleDocletException instead of InternalException because there is nothing
-configuration.reporter.print(ERROR, "Unknown element: " + component);
+// informative about about the place the exception occurred, here in this method.
-throw new DocletAbortException(e);
+// The problem is either a misconfigured doclet.xml file or a missing method in the
+// user-supplied(?) doclet
+String message = resources.getText("doclet.builder.unknown.component", component);
+throw new SimpleDocletException(message, e);
 } catch (InvocationTargetException e) {
 Throwable cause = e.getCause();
-if (cause instanceof DocletAbortException) {
+if (cause instanceof DocletException) {
-throw (DocletAbortException) cause;
+throw (DocletException) cause;
 } else {
-throw new DocletAbortException(e.getCause());
+// use InternalException, so that a stacktrace showing the position of
+// the internal exception is generated
+String message = resources.getText("doclet.builder.exception.in.component", component,
+e.getCause());
+throw new InternalException(message, e.getCause());
 }
-} catch (Exception e) {
-e.printStackTrace(System.err);
+} catch (ReflectiveOperationException e) {
-configuration.reporter.print(ERROR, "Exception " +
+// Use SimpleDocletException instead of InternalException because there is nothing
-e.getClass().getName() +
+// informative about about the place the exception occurred, here in this method.
-" thrown while processing element: " + component);
+// The problem is specific to the method being invoked, such as illegal access
-throw new DocletAbortException(e);
+// or illegal argument.
+String message = resources.getText("doclet.builder.exception.in.component", component, e);
+throw new SimpleDocletException(message, e.getCause());
 }
 }
 /**
 * Build the documentation, as specified by the children of the given XML element.
 *
 * @param node the XML element that specifies which components to document.
 * @param contentTree content tree to which the documentation will be added
+* @throws DocletException if there is a problem while building the children
 */
-protected void buildChildren(XMLNode node, Content contentTree) {
+protected void buildChildren(XMLNode node, Content contentTree) throws DocletException {
 for (XMLNode child : node.children)
 build(child, contentTree);
 }
-/**
-* Given the name and parameters, invoke the method in the builder.  This
-* method is required to invoke the appropriate build method as instructed
-* by the builder XML file.
-*
-* @param methodName   the name of the method that we would like to invoke.
-* @param paramClasses the types for each parameter.
-* @param params       the parameters of the method.
-*/
-protected void invokeMethod(String methodName, Class<?>[] paramClasses,
-Object[] params)
-throws Exception {
-if (DEBUG) {
-configuration.reporter.print(ERROR, "DEBUG: " +
-this.getClass().getName() + "." + methodName);
-}
-Method method = this.getClass().getMethod(methodName, paramClasses);
-method.invoke(this, params);
-}
 }

changeset 40587	1c355ea550ed
parent 40303	96a1226aca18
child 43261	d377e97291d8