duke@1: /* jjg@1357: * Copyright (c) 1998, 2012, 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.util; duke@1: duke@1: import java.io.*; duke@1: import java.util.*; duke@1: jjg@1357: import com.sun.javadoc.*; jjg@1357: import com.sun.tools.doclets.internal.toolkit.*; jjg@1357: duke@1: /** duke@1: * Write out the package index. duke@1: * jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
duke@1: *
duke@1: * @see com.sun.javadoc.PackageDoc
duke@1: * @author Atul M Dambalkar
duke@1: */
duke@1: public class PackageListWriter extends PrintWriter {
duke@1:
duke@1: private Configuration configuration;
duke@1:
duke@1: /**
duke@1: * Constructor.
duke@1: *
duke@1: * @param configuration the current configuration of the doclet.
duke@1: */
duke@1: public PackageListWriter(Configuration configuration) throws IOException {
jjg@1383: super(DocFile.createFileForOutput(configuration, DocPaths.PACKAGE_LIST).openWriter());
duke@1: this.configuration = configuration;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Generate the package index.
duke@1: *
duke@1: * @param configuration the current configuration of the doclet.
duke@1: * @throws DocletAbortException
duke@1: */
duke@1: public static void generate(Configuration configuration) {
duke@1: PackageListWriter packgen;
duke@1: try {
duke@1: packgen = new PackageListWriter(configuration);
duke@1: packgen.generatePackageListFile(configuration.root);
duke@1: packgen.close();
duke@1: } catch (IOException exc) {
duke@1: configuration.message.error("doclet.exception_encountered",
jjg@1372: exc.toString(), DocPaths.PACKAGE_LIST);
duke@1: throw new DocletAbortException();
duke@1: }
duke@1: }
duke@1:
duke@1: protected void generatePackageListFile(RootDoc root) {
duke@1: PackageDoc[] packages = configuration.packages;
bpatel@995: ArrayList