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