| /* |
| * Copyright (c) 2003, 2017, Oracle and/or its affiliates. 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. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package jdk.javadoc.internal.doclets.toolkit.builders; |
| |
| import java.util.*; |
| |
| import javax.lang.model.element.PackageElement; |
| |
| import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration; |
| import jdk.javadoc.internal.doclets.toolkit.DocletException; |
| import jdk.javadoc.internal.doclets.toolkit.Messages; |
| import jdk.javadoc.internal.doclets.toolkit.Resources; |
| import jdk.javadoc.internal.doclets.toolkit.util.Utils; |
| |
| |
| /** |
| * The superclass for all builders. A builder is a class that provides |
| * the structure and content of API documentation. A builder is completely |
| * doclet independent which means that any doclet can use builders to |
| * construct documentation, as long as it implements the appropriate |
| * writer interfaces. For example, if a doclet wanted to use |
| * {@link ConstantsSummaryBuilder} to build a constant summary, all it has to |
| * do is implement the ConstantsSummaryWriter interface and pass it to the |
| * builder using a WriterFactory. |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| * |
| * @author Jamie Ho |
| */ |
| |
| public abstract class AbstractBuilder { |
| public static class Context { |
| /** |
| * The configuration used in this run of the doclet. |
| */ |
| final BaseConfiguration configuration; |
| |
| /** |
| * Keep track of which packages we have seen for |
| * efficiency purposes. We don't want to copy the |
| * doc files multiple times for a single package. |
| */ |
| final Set<PackageElement> containingPackagesSeen; |
| |
| Context(BaseConfiguration configuration, Set<PackageElement> containingPackagesSeen) { |
| this.configuration = configuration; |
| this.containingPackagesSeen = containingPackagesSeen; |
| } |
| } |
| |
| /** |
| * The configuration used in this run of the doclet. |
| */ |
| protected final BaseConfiguration configuration; |
| |
| protected final BuilderFactory builderFactory; |
| protected final Messages messages; |
| protected final Resources resources; |
| protected final Utils utils; |
| |
| /** |
| * Keep track of which packages we have seen for |
| * efficiency purposes. We don't want to copy the |
| * doc files multiple times for a single package. |
| */ |
| protected final Set<PackageElement> containingPackagesSeen; |
| |
| /** |
| * Construct a Builder. |
| * @param c a context providing information used in this run of the doclet |
| */ |
| public AbstractBuilder(Context c) { |
| this.configuration = c.configuration; |
| this.builderFactory = configuration.getBuilderFactory(); |
| this.messages = configuration.getMessages(); |
| this.resources = configuration.getResources(); |
| this.utils = configuration.utils; |
| this.containingPackagesSeen = c.containingPackagesSeen; |
| } |
| |
| /** |
| * Build the documentation. |
| * |
| * @throws DocletException if there is a problem building the documentation |
| */ |
| public abstract void build() throws DocletException; |
| } |