jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/util/PackageListWriter.java@c75be5bc5283

     1 /*

     2  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    26 package com.sun.tools.doclets.internal.toolkit.util;

    28 import java.io.*;

    29 import java.util.*;

    31 import com.sun.javadoc.*;

    32 import com.sun.tools.doclets.internal.toolkit.*;

    34 /**

    35  * Write out the package index.

    36  *

    37  * This code is not part of an API.

    38  * It is implementation that is subject to change.

    39  * Do not use it as an API

    40  *

    41  * @see com.sun.javadoc.PackageDoc

    42  * @author Atul M Dambalkar

    43  */

    44 public class PackageListWriter extends PrintWriter {

    46     private Configuration configuration;

    48     /**

    49      * Constructor.

    50      *

    51      * @param configuration the current configuration of the doclet.

    52      */

    53     public PackageListWriter(Configuration configuration) throws IOException {

    54         super(Util.genWriter(configuration, configuration.destDirName,

    55             DocletConstants.PACKAGE_LIST_FILE_NAME, configuration.docencoding));

    56         this.configuration = configuration;

    57     }

    59     /**

    60      * Generate the package index.

    61      *

    62      * @param configuration the current configuration of the doclet.

    63      * @throws DocletAbortException

    64      */

    65     public static void generate(Configuration configuration) {

    66         PackageListWriter packgen;

    67         try {

    68             packgen = new PackageListWriter(configuration);

    69             packgen.generatePackageListFile(configuration.root);

    70             packgen.close();

    71         } catch (IOException exc) {

    72             configuration.message.error("doclet.exception_encountered",

    73                 exc.toString(), DocletConstants.PACKAGE_LIST_FILE_NAME);

    74             throw new DocletAbortException();

    75         }

    76     }

    78     protected void generatePackageListFile(RootDoc root) {

    79         PackageDoc[] packages = configuration.packages;

    80         ArrayList<String> names = new ArrayList<String>();

    81         for (int i = 0; i < packages.length; i++) {

    82             // if the -nodeprecated option is set and the package is marked as

    83             // deprecated, do not include it in the packages list.

    84             if (!(configuration.nodeprecated && Util.isDeprecated(packages[i])))

    85                 names.add(packages[i].name());

    86         }

    87         Collections.sort(names);

    88         for (int i = 0; i < names.size(); i++) {

    89             println(names.get(i));

    90         }

    91     }

    92 }

Mercurial > jdk8-mips64-public > langtools / file revision