src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java
changeset 47216 71c04702a3d5
parent 45599 8bc3a019f948
child 49879 601277b1d582
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java	Tue Sep 12 19:03:39 2017 +0200
@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2003, 2017, 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
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * 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 jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletException;
+
+/**
+ * The superclass for all member builders.  Member builders are only executed
+ * within Class Builders.  They essentially build sub-components.  For example,
+ * method documentation is a sub-component of class documentation.
+ *
+ *  <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.
+ *  This code and its internal interfaces are subject to change or
+ *  deletion without notice.</b>
+ *
+ * @author Jamie Ho
+ */
+public abstract class AbstractMemberBuilder extends AbstractBuilder {
+
+    /**
+     * Construct a SubBuilder.
+     * @param context a context object, providing information used in this run
+     *        of the doclet.
+     */
+    public AbstractMemberBuilder(Context context) {
+        super(context);
+    }
+
+    /**
+     * This method is not supported by sub-builders.
+     *
+     * @throws AssertionError always
+     */
+    @Override
+    public void build() {
+        // You may not call the build method in a subbuilder.
+        throw new AssertionError();
+    }
+
+    /**
+     *
+     * Build the documentation.
+     *
+     * @param contentTree The content tree into which to add the documention
+     * @throws DocletException  if there is a problem building the documentation
+     */
+    public abstract void build(Content contentTree) throws DocletException;
+
+    /**
+     * Returns true if this subbuilder has anything to document.
+     *
+     * @return true if this subbuilder has anything to document
+     */
+    public abstract boolean hasMembersToDocument();
+}