Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/PackageListWriter.java@9d9f26857129 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/PackageListWriter.java
Tue, 25 May 2010 15:54:51 -0700
- author
- ohair
- date
- Tue, 25 May 2010 15:54:51 -0700
- changeset 554
- 9d9f26857129
- parent 1
- 9a66ca7c79fa
- child 995
- 62bc3775d5bb
- permissions
- -rw-r--r--
6943119: Rebrand source copyright notices
Reviewed-by: darcy
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.util; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.*; |
| duke@1 | 29 | import com.sun.javadoc.*; |
| duke@1 | 30 | import java.io.*; |
| duke@1 | 31 | import java.util.*; |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * Write out the package index. |
| duke@1 | 35 | * |
| duke@1 | 36 | * This code is not part of an API. |
| duke@1 | 37 | * It is implementation that is subject to change. |
| duke@1 | 38 | * Do not use it as an API |
| duke@1 | 39 | * |
| duke@1 | 40 | * @see com.sun.javadoc.PackageDoc |
| duke@1 | 41 | * @author Atul M Dambalkar |
| duke@1 | 42 | */ |
| duke@1 | 43 | public class PackageListWriter extends PrintWriter { |
| duke@1 | 44 | |
| duke@1 | 45 | private Configuration configuration; |
| duke@1 | 46 | |
| duke@1 | 47 | /** |
| duke@1 | 48 | * Constructor. |
| duke@1 | 49 | * |
| duke@1 | 50 | * @param configuration the current configuration of the doclet. |
| duke@1 | 51 | */ |
| duke@1 | 52 | public PackageListWriter(Configuration configuration) throws IOException { |
| duke@1 | 53 | super(Util.genWriter(configuration, configuration.destDirName, |
| duke@1 | 54 | DocletConstants.PACKAGE_LIST_FILE_NAME, configuration.docencoding)); |
| duke@1 | 55 | this.configuration = configuration; |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | /** |
| duke@1 | 59 | * Generate the package index. |
| duke@1 | 60 | * |
| duke@1 | 61 | * @param configuration the current configuration of the doclet. |
| duke@1 | 62 | * @throws DocletAbortException |
| duke@1 | 63 | */ |
| duke@1 | 64 | public static void generate(Configuration configuration) { |
| duke@1 | 65 | PackageListWriter packgen; |
| duke@1 | 66 | try { |
| duke@1 | 67 | packgen = new PackageListWriter(configuration); |
| duke@1 | 68 | packgen.generatePackageListFile(configuration.root); |
| duke@1 | 69 | packgen.close(); |
| duke@1 | 70 | } catch (IOException exc) { |
| duke@1 | 71 | configuration.message.error("doclet.exception_encountered", |
| duke@1 | 72 | exc.toString(), DocletConstants.PACKAGE_LIST_FILE_NAME); |
| duke@1 | 73 | throw new DocletAbortException(); |
| duke@1 | 74 | } |
| duke@1 | 75 | } |
| duke@1 | 76 | |
| duke@1 | 77 | protected void generatePackageListFile(RootDoc root) { |
| duke@1 | 78 | PackageDoc[] packages = configuration.packages; |
| duke@1 | 79 | String[] names = new String[packages.length]; |
| duke@1 | 80 | for (int i = 0; i < packages.length; i++) { |
| duke@1 | 81 | names[i] = packages[i].name(); |
| duke@1 | 82 | } |
| duke@1 | 83 | Arrays.sort(names); |
| duke@1 | 84 | for (int i = 0; i < packages.length; i++) { |
| duke@1 | 85 | println(names[i]); |
| duke@1 | 86 | } |
| duke@1 | 87 | } |
| duke@1 | 88 | } |
