1 /*

     2  * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package jdk.javadoc.internal.doclets.toolkit.builders;

    27 

    28 import jdk.javadoc.internal.doclets.toolkit.Content;

    29 import jdk.javadoc.internal.doclets.toolkit.DocletException;

    30 

    31 /**

    32  * The superclass for all member builders.  Member builders are only executed

    33  * within Class Builders.  They essentially build sub-components.  For example,

    34  * method documentation is a sub-component of class documentation.

    35  *

    36  *  <p><b>This is NOT part of any supported API.

    37  *  If you write code that depends on this, you do so at your own risk.

    38  *  This code and its internal interfaces are subject to change or

    39  *  deletion without notice.</b>

    40  *

    41  * @author Jamie Ho

    42  */

    43 public abstract class AbstractMemberBuilder extends AbstractBuilder {

    44 

    45     /**

    46      * Construct a SubBuilder.

    47      * @param context a context object, providing information used in this run

    48      *        of the doclet.

    49      */

    50     public AbstractMemberBuilder(Context context) {

    51         super(context);

    52     }

    53 

    54     /**

    55      * This method is not supported by sub-builders.

    56      *

    57      * @throws AssertionError always

    58      */

    59     @Override

    60     public void build() {

    61         // You may not call the build method in a subbuilder.

    62         throw new AssertionError();

    63     }

    64 

    65     /**

    66      *

    67      * Build the documentation.

    68      *

    69      * @param contentTree The content tree into which to add the documention

    70      * @throws DocletException  if there is a problem building the documentation

    71      */

    72     public abstract void build(Content contentTree) throws DocletException;

    73 

    74     /**

    75      * Returns true if this subbuilder has anything to document.

    76      *

    77      * @return true if this subbuilder has anything to document

    78      */

    79     public abstract boolean hasMembersToDocument();

    80 }