1 /*

     2  * Copyright (c) 1998, 2017, 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  */

    25 

    26 package jdk.javadoc.internal.doclets.toolkit.util;

    27 

    28 import java.io.*;

    29 

    30 import javax.lang.model.element.ModuleElement;

    31 import javax.lang.model.element.PackageElement;

    32 

    33 import jdk.javadoc.doclet.DocletEnvironment;

    34 import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;

    35 

    36 

    37 /**

    38  * Write out the element index.

    39  *

    40  *  <p><b>This is NOT part of any supported API.

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

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

    43  *  deletion without notice.</b>

    44  *

    45  * @author Atul M Dambalkar

    46  */

    47 public class ElementListWriter {

    48 

    49     private final BaseConfiguration configuration;

    50     private final Utils utils;

    51     private final DocFile file;

    52 

    53     /**

    54      * Constructor.

    55      *

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

    57      */

    58     public ElementListWriter(BaseConfiguration configuration) {

    59         file = DocFile.createFileForOutput(configuration, DocPaths.ELEMENT_LIST);

    60         this.configuration = configuration;

    61         this.utils = configuration.utils;

    62     }

    63 

    64     /**

    65      * Generate the element index.

    66      *

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

    68      * @throws DocFileIOException if there is a problem writing the output

    69      */

    70     public static void generate(BaseConfiguration configuration) throws DocFileIOException {

    71         ElementListWriter elemgen = new ElementListWriter(configuration);

    72         elemgen.generateElementListFile(configuration.docEnv);

    73     }

    74 

    75     protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException {

    76         try (BufferedWriter out = new BufferedWriter(file.openWriter())) {

    77             if (configuration.showModules) {

    78                 for (ModuleElement mdle : configuration.modulePackages.keySet()) {

    79                     if (!(configuration.nodeprecated && utils.isDeprecated(mdle))) {

    80                         out.write(DocletConstants.MODULE_PREFIX + mdle.toString());

    81                         out.newLine();

    82                         for (PackageElement pkg : configuration.modulePackages.get(mdle)) {

    83                             out.write(pkg.toString());

    84                             out.newLine();

    85                         }

    86                     }

    87                 }

    88             } else {

    89                 for (PackageElement pkg : configuration.packages) {

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

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

    92                     if (!(configuration.nodeprecated && utils.isDeprecated(pkg))) {

    93                         out.write(pkg.toString());

    94                         out.newLine();

    95                     }

    96                 }

    97             }

    98         } catch (IOException e) {

    99             throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);

   100         }

   101     }

   102 }