View Javadoc
1   /*
2    * Copyright (c) 1998, 2006, 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  
26  package 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  public interface RootDoc extends Doc, DocErrorReporter {
39  
40      /**
41       * Command line options.
42       * <p>
43       * For example, given:
44       * <pre>
45       *     javadoc -foo this that -bar other ...</pre>
46       *
47       * this method will return:
48       * <pre>
49       *      options()[0][0] = "-foo"
50       *      options()[0][1] = "this"
51       *      options()[0][2] = "that"
52       *      options()[1][0] = "-bar"
53       *      options()[1][1] = "other"</pre>
54       *
55       * @return an array of arrays of String.
56       */
57      String[][] options();
58  
59      /**
60       * Return the packages
61       * <a href="package-summary.html#included">specified</a>
62       * on the command line.
63       * If <code>-subpackages</code> and <code>-exclude</code> options
64       * are used, return all the non-excluded packages.
65       *
66       * @return packages specified on the command line.
67       */
68      PackageDoc[] specifiedPackages();
69  
70      /**
71       * Return the classes and interfaces
72       * <a href="package-summary.html#included">specified</a>
73       * as source file names on the command line.
74       *
75       * @return classes and interfaces specified on the command line.
76       */
77      ClassDoc[] specifiedClasses();
78  
79      /**
80       * Return the
81       * <a href="package-summary.html#included">included</a>
82        classes and interfaces in all packages.
83       *
84       * @return included classes and interfaces in all packages.
85       */
86      ClassDoc[] classes();
87  
88      /**
89       * Return a PackageDoc for the specified package name.
90       *
91       * @param name package name
92       *
93       * @return a PackageDoc holding the specified package, null if
94       * this package is not referenced.
95       */
96      PackageDoc packageNamed(String name);
97  
98      /**
99       * Return a ClassDoc for the specified class or interface name.
100      *
101      * @param qualifiedName
102      * <a href="package-summary.html#qualified">qualified</a>
103      * class or package name
104      *
105      * @return a ClassDoc holding the specified class, null if
106      * this class is not referenced.
107      */
108     ClassDoc classNamed(String qualifiedName);
109 }