1 /*
   2  * Copyright (c) 1998, 2019, 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 import jdk.javadoc.internal.doclets.toolkit.BaseOptions;
  36 
  37 
  38 /**
  39  * Write out the element index.
  40  *
  41  *  <p><b>This is NOT part of any supported API.
  42  *  If you write code that depends on this, you do so at your own risk.
  43  *  This code and its internal interfaces are subject to change or
  44  *  deletion without notice.</b>
  45  */
  46 public class ElementListWriter {
  47 
  48     private final BaseConfiguration configuration;
  49     private final BaseOptions options;
  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.options = configuration.getOptions();
  62         this.utils = configuration.utils;
  63     }
  64 
  65     /**
  66      * Generate the element index.
  67      *
  68      * @param configuration the current configuration of the doclet.
  69      * @throws DocFileIOException if there is a problem writing the output
  70      */
  71     public static void generate(BaseConfiguration configuration) throws DocFileIOException {
  72         ElementListWriter elemgen = new ElementListWriter(configuration);
  73         elemgen.generateElementListFile(configuration.docEnv);
  74     }
  75 
  76     protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException {
  77         try (BufferedWriter out = new BufferedWriter(file.openWriter())) {
  78             if (configuration.showModules) {
  79                 for (ModuleElement mdle : configuration.modulePackages.keySet()) {
  80                     if (!(options.noDeprecated && utils.isDeprecated(mdle))) {
  81                         out.write(DocletConstants.MODULE_PREFIX + mdle.toString());
  82                         out.newLine();
  83                         for (PackageElement pkg : configuration.modulePackages.get(mdle)) {
  84                             out.write(pkg.toString());
  85                             out.newLine();
  86                         }
  87                     }
  88                 }
  89             } else {
  90                 for (PackageElement pkg : configuration.packages) {
  91                     // if the -nodeprecated option is set and the package is marked as
  92                     // deprecated, do not include it in the packages list.
  93                     if (!(options.noDeprecated && utils.isDeprecated(pkg))) {
  94                         out.write(pkg.toString());
  95                         out.newLine();
  96                     }
  97                 }
  98             }
  99         } catch (IOException e) {
 100             throw new DocFileIOException(file, DocFileIOException.Mode.WRITE, e);
 101         }
 102     }
 103 }