diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/AbstractMemberBuilder.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,84 @@ +/* + * Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package com.sun.tools.doclets.internal.toolkit.builders; + +import com.sun.tools.doclets.internal.toolkit.*; +import com.sun.tools.doclets.internal.toolkit.util.*; +import java.util.*; + +/** + * 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. + * + * This code is not part of an API. + * It is implementation that is subject to change. + * Do not use it as an API + * + * @author Jamie Ho + * @since 1.5 + */ +public abstract class AbstractMemberBuilder extends AbstractBuilder { + + /** + * Construct a SubBuilder. + * @param configuration the configuration used in this run + * of the doclet. + */ + public AbstractMemberBuilder(Configuration configuration) { + super(configuration); + } + + /** + * This method is not supported by sub-builders. + * + * @throws DocletAbortException this method will always throw a + * DocletAbortException because it is not supported. + */ + public void build() throws DocletAbortException { + //You may not call the build method in a subbuilder. + throw new DocletAbortException(); + } + + + /** + * Build the sub component if there is anything to document. + * + * @param elements {@inheritDoc} + */ + public void build(List elements) { + if (hasMembersToDocument()) { + super.build(elements); + } + } + + /** + * Return true if this subbuilder has anything to document. + * + * @return true if this subbuilder has anything to document. + */ + public abstract boolean hasMembersToDocument(); +}