ConstantsSummaryBuilder.java revision 765
* Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * Builds the Constants Summary Page. * This code is not part of an API. * It is implementation that is subject to change. * Do not use it as an API * @author Bhavesh Patel (Modified) * The root element of the constant summary XML is {@value}. public static final String ROOT =
"ConstantSummary";
* The maximum number of package directories shown in the constant * The writer used to write the results. * The set of ClassDocs that have constant fields. * The set of printed package headers. * The current package being documented. * The current class being documented. * The content tree for the constant summary documentation. * Construct a new ConstantsSummaryBuilder. * @param configuration the current configuration of the * Construct a ConstantsSummaryBuilder. * @param configuration the configuration used in this run * @param writer the writer for the summary. //Doclet does not support this output. * Build the constant summary. * @param node the XML element that specifies which components to document * @param contentTree the content tree to which the documentation will be added * Build the list of packages. * @param node the XML element that specifies which components to document * @param contentTree the content tree to which the content list will be added * Build the summary for each documented package. * @param node the XML element that specifies which components to document * @param contentTree the tree to which the summaries will be added //Build the documentation for the current package. * Build the header for the given package. * @param node the XML element that specifies which components to document * @param summariesTree the tree to which the package header will be added * Build the summary for the current class. * @param node the XML element that specifies which components to document * @param summariesTree the tree to which the class constant summary will be added //Build the documentation for the current class. * Build the summary of constant members in the class. * @param node the XML element that specifies which components to document * @param classConstantTree the tree to which the constant members table * Return true if the given package has constant fields to document. * @param pkg the package being checked. * @return true if the given package has constant fields to document. * Return true if the given class has constant fields to document. * @param classDoc the class being checked. * @return true if the given package has constant fields to document. * Return true if the given package name has been printed. Also * return true if the root of this package has been printed. * @param pkgname the name of the package to check. * Print the table of constants. * The map used to get the visible variables. * The map used to get the visible variables. * The classdoc that we are examining constants for. * Construct a ConstantFieldSubWriter. * @param classdoc the classdoc that we are examining constants for. * Builds the table of constants for a given class. * @param node the XML element that specifies which components to document * @param classConstantTree the tree to which the class constants table * Return the list of visible constant fields for the given classdoc. * @param cd the classdoc to examine. * @return the list of visible constant fields for the given classdoc. * Parse the package name. We only want to display package name up to