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

8000666: javadoc should write directly to Writer instead of composing strings
Reviewed-by: bpatel

     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  *  <p><b>This is NOT part of any supported API.

    38  *  If you write code that depends on this, you do so at your own risk.

    39  *  This code and its internal interfaces are subject to change or

    40  *  deletion without notice.</b>

    41  *

    42  * @see com.sun.javadoc.PackageDoc

    43  * @author Atul M Dambalkar

    44  */

    45 public class PackageListWriter extends PrintWriter {

    47     private Configuration configuration;

    49     /**

    50      * Constructor.

    51      *

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

    53      */

    54     public PackageListWriter(Configuration configuration) throws IOException {

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

    56             DocletConstants.PACKAGE_LIST_FILE_NAME, configuration.docencoding));

    57         this.configuration = configuration;

    58     }

    60     /**

    61      * Generate the package index.

    62      *

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

    64      * @throws DocletAbortException

    65      */

    66     public static void generate(Configuration configuration) {

    67         PackageListWriter packgen;

    68         try {

    69             packgen = new PackageListWriter(configuration);

    70             packgen.generatePackageListFile(configuration.root);

    71             packgen.close();

    72         } catch (IOException exc) {

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

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

    75             throw new DocletAbortException();

    76         }

    77     }

    79     protected void generatePackageListFile(RootDoc root) {

    80         PackageDoc[] packages = configuration.packages;

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

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

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

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

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

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

    87         }

    88         Collections.sort(names);

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

    90             println(names.get(i));

    91         }

    92     }

    93 }

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