duke@1: /*
ohair@554:  * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.javadoc;
duke@1: 
duke@1: /**
duke@1:  * Represents the root of the program structure information
duke@1:  * for one run of javadoc.  From this root all other program
duke@1:  * structure information can be extracted.
duke@1:  * Also represents the command line information -- the
duke@1:  * packages, classes and options specified by the user.
duke@1:  *
duke@1:  * @since 1.2
duke@1:  * @author Robert Field
duke@1:  */
duke@1: public interface RootDoc extends Doc, DocErrorReporter {
duke@1: 
duke@1:     /**
duke@1:      * Command line options.
duke@1:      * <p>
duke@1:      * For example, given:
duke@1:      * <pre>
duke@1:      *     javadoc -foo this that -bar other ...</pre>
duke@1:      *
duke@1:      * this method will return:
duke@1:      * <pre>
duke@1:      *      options()[0][0] = "-foo"
duke@1:      *      options()[0][1] = "this"
duke@1:      *      options()[0][2] = "that"
duke@1:      *      options()[1][0] = "-bar"
duke@1:      *      options()[1][1] = "other"</pre>
duke@1:      *
duke@1:      * @return an array of arrays of String.
duke@1:      */
duke@1:     String[][] options();
duke@1: 
duke@1:     /**
duke@1:      * Return the packages
duke@1:      * <a href="package-summary.html#included">specified</a>
duke@1:      * on the command line.
duke@1:      * If <code>-subpackages</code> and <code>-exclude</code> options
duke@1:      * are used, return all the non-excluded packages.
duke@1:      *
duke@1:      * @return packages specified on the command line.
duke@1:      */
duke@1:     PackageDoc[] specifiedPackages();
duke@1: 
duke@1:     /**
duke@1:      * Return the classes and interfaces
duke@1:      * <a href="package-summary.html#included">specified</a>
duke@1:      * as source file names on the command line.
duke@1:      *
duke@1:      * @return classes and interfaces specified on the command line.
duke@1:      */
duke@1:     ClassDoc[] specifiedClasses();
duke@1: 
duke@1:     /**
duke@1:      * Return the
duke@1:      * <a href="package-summary.html#included">included</a>
duke@1:       classes and interfaces in all packages.
duke@1:      *
duke@1:      * @return included classes and interfaces in all packages.
duke@1:      */
duke@1:     ClassDoc[] classes();
duke@1: 
duke@1:     /**
duke@1:      * Return a PackageDoc for the specified package name.
duke@1:      *
duke@1:      * @param name package name
duke@1:      *
duke@1:      * @return a PackageDoc holding the specified package, null if
duke@1:      * this package is not referenced.
duke@1:      */
duke@1:     PackageDoc packageNamed(String name);
duke@1: 
duke@1:     /**
duke@1:      * Return a ClassDoc for the specified class or interface name.
duke@1:      *
duke@1:      * @param qualifiedName
duke@1:      * <a href="package-summary.html#qualified">qualified</a>
duke@1:      * class or package name
duke@1:      *
duke@1:      * @return a ClassDoc holding the specified class, null if
duke@1:      * this class is not referenced.
duke@1:      */
duke@1:     ClassDoc classNamed(String qualifiedName);
duke@1: }