aoqi@0: /*
aoqi@0:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit.builders;
aoqi@0: 
aoqi@0: import java.util.Set;
aoqi@0: 
aoqi@0: import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * The superclass for all member builders.  Member builders are only executed
aoqi@0:  * within Class Builders.  They essentially build sub-components.  For example,
aoqi@0:  * method documentation is a sub-component of class documentation.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Jamie Ho
aoqi@0:  * @since 1.5
aoqi@0:  */
aoqi@0: public abstract class AbstractMemberBuilder extends AbstractBuilder {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Construct a SubBuilder.
aoqi@0:      * @param configuration the configuration used in this run
aoqi@0:      *        of the doclet.
aoqi@0:      */
aoqi@0:     public AbstractMemberBuilder(Context context) {
aoqi@0:         super(context);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method is not supported by sub-builders.
aoqi@0:      *
aoqi@0:      * @throws DocletAbortException this method will always throw a
aoqi@0:      * DocletAbortException because it is not supported.
aoqi@0:      */
aoqi@0:     public void build() throws DocletAbortException {
aoqi@0:         //You may not call the build method in a subbuilder.
aoqi@0:         throw new DocletAbortException("not supported");
aoqi@0:     }
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Build the sub component if there is anything to document.
aoqi@0:      *
aoqi@0:      * @param node the XML element that specifies which components to document.
aoqi@0:      * @param contentTree content tree to which the documentation will be added
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public void build(XMLNode node, Content contentTree) {
aoqi@0:         if (hasMembersToDocument()) {
aoqi@0:             super.build(node, contentTree);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if this subbuilder has anything to document.
aoqi@0:      *
aoqi@0:      * @return true if this subbuilder has anything to document.
aoqi@0:      */
aoqi@0:     public abstract boolean hasMembersToDocument();
aoqi@0: }