duke@1: /*
ohair@554:  * Copyright (c) 1998, 2003, 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 com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.javadoc.*;
duke@1: import java.io.*;
duke@1: import java.util.*;
duke@1: 
duke@1: /**
duke@1:  * Write out the package index.
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:  * @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 {
duke@1:         super(Util.genWriter(configuration, configuration.destDirName,
duke@1:             DocletConstants.PACKAGE_LIST_FILE_NAME, configuration.docencoding));
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",
duke@1:                 exc.toString(), DocletConstants.PACKAGE_LIST_FILE_NAME);
duke@1:             throw new DocletAbortException();
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected void generatePackageListFile(RootDoc root) {
duke@1:         PackageDoc[] packages = configuration.packages;
duke@1:         String[] names = new String[packages.length];
duke@1:         for (int i = 0; i < packages.length; i++) {
duke@1:             names[i] = packages[i].name();
duke@1:         }
duke@1:         Arrays.sort(names);
duke@1:         for (int i = 0; i < packages.length; i++) {
duke@1:             println(names[i]);
duke@1:         }
duke@1:     }
duke@1: }