AbstractMemberBuilder.java revision 0
0N/A/*
0N/A * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
0N/A * published by the Free Software Foundation. Sun designates this
0N/A * particular file as subject to the "Classpath" exception as provided
0N/A * by Sun in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
0N/A * CA 95054 USA or visit www.sun.com if you need additional information or
0N/A * have any questions.
0N/A */
0N/A
0N/Apackage com.sun.tools.doclets.internal.toolkit.builders;
0N/A
0N/Aimport com.sun.tools.doclets.internal.toolkit.*;
0N/Aimport com.sun.tools.doclets.internal.toolkit.util.*;
0N/Aimport java.util.*;
0N/A
0N/A/**
0N/A * The superclass for all member builders. Member builders are only executed
0N/A * within Class Builders. They essentially build sub-components. For example,
0N/A * method documentation is a sub-component of class documentation.
0N/A *
0N/A * This code is not part of an API.
0N/A * It is implementation that is subject to change.
0N/A * Do not use it as an API
0N/A *
0N/A * @author Jamie Ho
0N/A * @since 1.5
0N/A */
0N/Apublic abstract class AbstractMemberBuilder extends AbstractBuilder {
0N/A
0N/A /**
0N/A * Construct a SubBuilder.
0N/A * @param configuration the configuration used in this run
0N/A * of the doclet.
0N/A */
0N/A public AbstractMemberBuilder(Configuration configuration) {
0N/A super(configuration);
0N/A }
0N/A
0N/A /**
0N/A * This method is not supported by sub-builders.
0N/A *
0N/A * @throws DocletAbortException this method will always throw a
0N/A * DocletAbortException because it is not supported.
0N/A */
0N/A public void build() throws DocletAbortException {
0N/A //You may not call the build method in a subbuilder.
0N/A throw new DocletAbortException();
0N/A }
0N/A
0N/A
0N/A /**
0N/A * Build the sub component if there is anything to document.
0N/A *
0N/A * @param elements {@inheritDoc}
0N/A */
0N/A public void build(List elements) {
0N/A if (hasMembersToDocument()) {
0N/A super.build(elements);
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Return true if this subbuilder has anything to document.
0N/A *
0N/A * @return true if this subbuilder has anything to document.
0N/A */
0N/A public abstract boolean hasMembersToDocument();
0N/A}