RootDoc


1   /*
2    * @(#)RootDoc.java 1.13 02/10/06
3    *
4    * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5    * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6    */
7   
8   package com.sun.javadoc;
9   
10  /**
11   * Represents the root of the program structure information 
12   * for one run of javadoc.  From this root all other program
13   * structure information can be extracted. 
14   * Also represents the command line information -- the 
15   * packages, classes and options specified by the user. 
16   *
17   * @since JDK1.2
18   * @author Robert Field
19   */
20  public interface RootDoc extends Doc, DocErrorReporter {
21  
22      /**
23       * Command line options.
24       * <p>
25       * For example, given:
26       * <pre>
27       *     javadoc -foo this that -bar other ...</pre>
28       *
29       * this method will return:
30       * <pre>
31       *      options()[0][0] = "-foo"
32       *      options()[0][1] = "this"
33       *      options()[0][2] = "that"
34       *      options()[1][0] = "-bar"
35       *      options()[1][1] = "other"</pre>
36       *
37       * @return an array of arrays of String.
38       */
39      String  [][] options();
40  
41      /**
42       * Return the packages 
43       * <a HREF="package-summary.html#included">specified</a>
44       * on the command line.
45       * If <code>-subpackages</code> and <code>-exclude</code> options 
46       * are used, return all the non-excluded packages.
47       *
48       * @return packages specified on the command line.
49       */
50      PackageDoc[] specifiedPackages();
51  
52      /**
53       * Return the classes and interfaces 
54       * <a HREF="package-summary.html#included">specified</a>
55       * as source file names on the command line.
56       *
57       * @return classes and interfaces specified on the command line.
58       */
59      ClassDoc[] specifiedClasses();
60  
61      /**
62       * Return the 
63       * <a HREF="package-summary.html#included">included</a>
64        classes and interfaces in all packages.
65       *
66       * @return included classes and interfaces in all packages.
67       */
68      ClassDoc[] classes();
69  
70      /**
71       * Return a PackageDoc for the specified package name.
72       *
73       * @param name package name
74       *
75       * @return a PackageDoc holding the specified package, null if
76       * this package is not referenced.
77       */
78      PackageDoc packageNamed(String   name);
79  
80      /**
81       * Return a ClassDoc for the specified class or interface name.
82       *
83       * @param qualifiedName 
84       * <a HREF="package-summary.html#qualified">qualified</a> 
85       * class or package name
86       *
87       * @return a ClassDoc holding the specified class, null if
88       * this class is not referenced.
89       */
90      ClassDoc classNamed(String   qualifiedName);
91  }
92
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags