duke@1: /*
duke@1:  * Copyright 2003 Sun Microsystems, Inc.  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
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun 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:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any 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.*;
duke@1: import java.io.*;
duke@1: import java.lang.reflect.*;
duke@1: import java.util.*;
duke@1: 
duke@1: /**
duke@1:  * The superclass for all builders.  A builder is a class that provides
duke@1:  * the structure and content of API documentation.  A builder is completely
duke@1:  * doclet independent which means that any doclet can use builders to
duke@1:  * construct documentation, as long as it impelements the appropriate
duke@1:  * writer interfaces.  For example, if a doclet wanted to use
duke@1:  * {@link ConstantsSummaryBuilder} to build a constant summary, all it has to
duke@1:  * do is implement the ConstantsSummaryWriter interface and pass it to the
duke@1:  * builder using a WriterFactory.
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: 
duke@1: public abstract class AbstractBuilder {
duke@1: 
duke@1:     /**
duke@1:      * The configuration used in this run of the doclet.
duke@1:      */
duke@1:     protected Configuration configuration;
duke@1: 
duke@1:     /**
duke@1:      * Keep track of which packages we have seen for
duke@1:      * efficiency purposes.  We don't want to copy the
duke@1:      * doc files multiple times for a single package.
duke@1:      */
jjg@74:     protected static Set<String> containingPackagesSeen;
duke@1: 
duke@1:     /**
duke@1:      * True if we want to print debug output.
duke@1:      */
duke@1:     protected static final boolean DEBUG = false;
duke@1: 
duke@1:     /**
duke@1:      * Construct a Builder.
duke@1:      * @param configuration the configuration used in this run
duke@1:      *        of the doclet.
duke@1:      */
duke@1:     public AbstractBuilder(Configuration configuration) {
duke@1:         this.configuration = configuration;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the name of this builder.
duke@1:      *
duke@1:      * @return the name of the builder.
duke@1:      */
duke@1:     public abstract String getName();
duke@1: 
duke@1:     /**
duke@1:      * Build the documentation.
duke@1:      *
duke@1:      * @throws IOException there was a problem writing the output.
duke@1:      */
duke@1:     public abstract void build() throws IOException;
duke@1: 
duke@1:     /**
duke@1:      * Build the documentation, as specified by the given XML elements.
duke@1:      *
duke@1:      * @param elements the XML elements that specify which components to
duke@1:      *                 document.
duke@1:      */
duke@1:     protected void build(List elements) {
duke@1:         for (int i = 0; i < elements.size(); i++ ) {
duke@1:             Object element = elements.get(i);
duke@1:             String component = (String)
duke@1:                 ((element instanceof String) ?
duke@1:                      element :
duke@1:                     ((List) element).get(0));
duke@1:             try {
duke@1:                 invokeMethod("build" + component,
duke@1:                     element instanceof String ?
duke@1:                         new Class[] {} :
duke@1:                         new Class[] {List.class},
duke@1:                     element instanceof String ?
duke@1:                         new Object[] {} :
duke@1:                         new Object[] {((List) element).subList(1,
duke@1:                             ((List) element).size())});
duke@1:             } catch (NoSuchMethodException e) {
duke@1:                 e.printStackTrace();
duke@1:                 configuration.root.printError("Unknown element: " + component);
duke@1:                 throw new DocletAbortException();
duke@1:             } catch (InvocationTargetException e) {
duke@1:                 e.getCause().printStackTrace();
duke@1:             } catch (Exception e) {
duke@1:                 e.printStackTrace();
duke@1:                 configuration.root.printError("Exception " +
duke@1:                     e.getClass().getName() +
duke@1:                     " thrown while processing element: " + component);
duke@1:                 throw new DocletAbortException();
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Given the name and parameters, invoke the method in the builder.  This
duke@1:      * method is required to invoke the appropriate build method as instructed
duke@1:      * by the builder XML file.
duke@1:      *
duke@1:      * @param methodName   the name of the method that we would like to invoke.
duke@1:      * @param paramClasses the types for each parameter.
duke@1:      * @param params       the parameters of the method.
duke@1:      */
duke@1:     protected abstract void invokeMethod(String methodName, Class[] paramClasses,
duke@1:             Object[] params)
duke@1:     throws Exception;
duke@1: }