aoqi@0: /*
aoqi@0:  * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit.util;
aoqi@0: 
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.Configuration;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Build list of all the deprecated packages, classes, constructors, fields and methods.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  */
aoqi@0: public class DeprecatedAPIListBuilder {
aoqi@0: 
aoqi@0:     public static final int NUM_TYPES = 12;
aoqi@0: 
aoqi@0:     public static final int PACKAGE = 0;
aoqi@0:     public static final int INTERFACE = 1;
aoqi@0:     public static final int CLASS = 2;
aoqi@0:     public static final int ENUM = 3;
aoqi@0:     public static final int EXCEPTION = 4;
aoqi@0:     public static final int ERROR = 5;
aoqi@0:     public static final int ANNOTATION_TYPE = 6;
aoqi@0:     public static final int FIELD = 7;
aoqi@0:     public static final int METHOD = 8;
aoqi@0:     public static final int CONSTRUCTOR = 9;
aoqi@0:     public static final int ENUM_CONSTANT = 10;
aoqi@0:     public static final int ANNOTATION_TYPE_MEMBER = 11;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * List of deprecated type Lists.
aoqi@0:      */
aoqi@0:     private List<List<Doc>> deprecatedLists;
aoqi@0: 
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructor.
aoqi@0:      *
aoqi@0:      * @param configuration the current configuration of the doclet
aoqi@0:      */
aoqi@0:     public DeprecatedAPIListBuilder(Configuration configuration) {
aoqi@0:         deprecatedLists = new ArrayList<List<Doc>>();
aoqi@0:         for (int i = 0; i < NUM_TYPES; i++) {
aoqi@0:             deprecatedLists.add(i, new ArrayList<Doc>());
aoqi@0:         }
aoqi@0:         buildDeprecatedAPIInfo(configuration);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Build the sorted list of all the deprecated APIs in this run.
aoqi@0:      * Build separate lists for deprecated packages, classes, constructors,
aoqi@0:      * methods and fields.
aoqi@0:      *
aoqi@0:      * @param configuration the current configuration of the doclet.
aoqi@0:      */
aoqi@0:     private void buildDeprecatedAPIInfo(Configuration configuration) {
aoqi@0:         PackageDoc[] packages = configuration.packages;
aoqi@0:         PackageDoc pkg;
aoqi@0:         for (int c = 0; c < packages.length; c++) {
aoqi@0:             pkg = packages[c];
aoqi@0:             if (Util.isDeprecated(pkg)) {
aoqi@0:                 getList(PACKAGE).add(pkg);
aoqi@0:             }
aoqi@0:         }
aoqi@0:         ClassDoc[] classes = configuration.root.classes();
aoqi@0:         for (int i = 0; i < classes.length; i++) {
aoqi@0:             ClassDoc cd = classes[i];
aoqi@0:             if (Util.isDeprecated(cd)) {
aoqi@0:                 if (cd.isOrdinaryClass()) {
aoqi@0:                     getList(CLASS).add(cd);
aoqi@0:                 } else if (cd.isInterface()) {
aoqi@0:                     getList(INTERFACE).add(cd);
aoqi@0:                 } else if (cd.isException()) {
aoqi@0:                     getList(EXCEPTION).add(cd);
aoqi@0:                 } else if (cd.isEnum()) {
aoqi@0:                     getList(ENUM).add(cd);
aoqi@0:                 } else if (cd.isError()) {
aoqi@0:                     getList(ERROR).add(cd);
aoqi@0:                 } else if (cd.isAnnotationType()) {
aoqi@0:                     getList(ANNOTATION_TYPE).add(cd);
aoqi@0:                 }
aoqi@0:             }
aoqi@0:             composeDeprecatedList(getList(FIELD), cd.fields());
aoqi@0:             composeDeprecatedList(getList(METHOD), cd.methods());
aoqi@0:             composeDeprecatedList(getList(CONSTRUCTOR), cd.constructors());
aoqi@0:             if (cd.isEnum()) {
aoqi@0:                 composeDeprecatedList(getList(ENUM_CONSTANT), cd.enumConstants());
aoqi@0:             }
aoqi@0:             if (cd.isAnnotationType()) {
aoqi@0:                 composeDeprecatedList(getList(ANNOTATION_TYPE_MEMBER),
aoqi@0:                         ((AnnotationTypeDoc) cd).elements());
aoqi@0:             }
aoqi@0:         }
aoqi@0:         sortDeprecatedLists();
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add the members into a single list of deprecated members.
aoqi@0:      *
aoqi@0:      * @param list List of all the particular deprecated members, e.g. methods.
aoqi@0:      * @param members members to be added in the list.
aoqi@0:      */
aoqi@0:     private void composeDeprecatedList(List<Doc> list, MemberDoc[] members) {
aoqi@0:         for (int i = 0; i < members.length; i++) {
aoqi@0:             if (Util.isDeprecated(members[i])) {
aoqi@0:                 list.add(members[i]);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Sort the deprecated lists for class kinds, fields, methods and
aoqi@0:      * constructors.
aoqi@0:      */
aoqi@0:     private void sortDeprecatedLists() {
aoqi@0:         for (int i = 0; i < NUM_TYPES; i++) {
aoqi@0:             Collections.sort(getList(i));
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the list of deprecated Doc objects of a given type.
aoqi@0:      *
aoqi@0:      * @param type the constant representing the type of list being returned.
aoqi@0:      */
aoqi@0:     public List<Doc> getList(int type) {
aoqi@0:         return deprecatedLists.get(type);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if the list of a given type has size greater than 0.
aoqi@0:      *
aoqi@0:      * @param type the type of list being checked.
aoqi@0:      */
aoqi@0:     public boolean hasDocumentation(int type) {
aoqi@0:         return (deprecatedLists.get(type)).size() > 0;
aoqi@0:     }
aoqi@0: }