1/*
2 * Copyright (c) 1998, 2014, 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
26package com.sun.javadoc;
27
28/**
29 * Represents the root of the program structure information
30 * for one run of javadoc.  From this root all other program
31 * structure information can be extracted.
32 * Also represents the command line information -- the
33 * packages, classes and options specified by the user.
34 *
35 * @since 1.2
36 * @author Robert Field
37 *
38 * @deprecated
39 *   The declarations in this package have been superseded by those
40 *   in the package {@code jdk.javadoc.doclet}.
41 *   For more information, see the <i>Migration Guide</i> in the documentation for that package.
42 */
43@Deprecated
44public interface RootDoc extends Doc, DocErrorReporter {
45
46    /**
47     * Command line options.
48     * <p>
49     * For example, given:
50     * <pre>
51     *     javadoc -foo this that -bar other ...</pre>
52     *
53     * this method will return:
54     * <pre>
55     *      options()[0][0] = "-foo"
56     *      options()[0][1] = "this"
57     *      options()[0][2] = "that"
58     *      options()[1][0] = "-bar"
59     *      options()[1][1] = "other"</pre>
60     *
61     * @return an array of arrays of String.
62     */
63    String[][] options();
64
65    /**
66     * Return the packages
67     * <a href="package-summary.html#included">specified</a>
68     * on the command line.
69     * If {@code -subpackages} and {@code -exclude} options
70     * are used, return all the non-excluded packages.
71     *
72     * @return packages specified on the command line.
73     */
74    PackageDoc[] specifiedPackages();
75
76    /**
77     * Return the classes and interfaces
78     * <a href="package-summary.html#included">specified</a>
79     * as source file names on the command line.
80     *
81     * @return classes and interfaces specified on the command line.
82     */
83    ClassDoc[] specifiedClasses();
84
85    /**
86     * Return the
87     * <a href="package-summary.html#included">included</a>
88      classes and interfaces in all packages.
89     *
90     * @return included classes and interfaces in all packages.
91     */
92    ClassDoc[] classes();
93
94    /**
95     * Return a PackageDoc for the specified package name.
96     *
97     * @param name package name
98     *
99     * @return a PackageDoc holding the specified package, null if
100     * this package is not referenced.
101     */
102    PackageDoc packageNamed(String name);
103
104    /**
105     * Return a ClassDoc for the specified class or interface name.
106     *
107     * @param qualifiedName
108     * <a href="package-summary.html#qualified">qualified</a>
109     * class or package name
110     *
111     * @return a ClassDoc holding the specified class, null if
112     * this class is not referenced.
113     */
114    ClassDoc classNamed(String qualifiedName);
115}
116