| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc (1.8.0) on Sun Aug 28 20:43:01 EST 2016 --> | |
| <title>ClassDep (Apache River v3.0.0 API Documentation (internals))</title> | |
| <meta name="date" content="2016-08-28"> | |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> | |
| <script type="text/javascript" src="../../../../script.js"></script> | |
| </head> | |
| <body> | |
| <script type="text/javascript"><!-- | |
| try { | |
| if (location.href.indexOf('is-external=true') == -1) { | |
| parent.document.title="ClassDep (Apache River v3.0.0 API Documentation (internals))"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":9,"i17":10,"i18":9,"i19":9,"i20":9,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":9}; | |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; | |
| var altColor = "altColor"; | |
| var rowColor = "rowColor"; | |
| var tableTab = "tableTab"; | |
| var activeTableTab = "activeTableTab"; | |
| </script> | |
| <noscript> | |
| <div>JavaScript is disabled on your browser.</div> | |
| </noscript> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <div class="topNav"><a name="navbar.top"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.top.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../overview-summary.html">Overview</a></li> | |
| <li><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/ClassDep.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../index-all.html">Index</a></li> | |
| <li><a href="../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../org/apache/river/tool/CheckSer.html" title="class in org.apache.river.tool"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/tool/ClassDep.Compare.html" title="class in org.apache.river.tool"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/tool/ClassDep.html" target="_top">Frames</a></li> | |
| <li><a href="ClassDep.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_top"> | |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"><!-- | |
| allClassesLink = document.getElementById("allclasses_navbar_top"); | |
| if(window==top) { | |
| allClassesLink.style.display = "block"; | |
| } | |
| else { | |
| allClassesLink.style.display = "none"; | |
| } | |
| //--> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </li> | |
| <li><a href="#method.detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip.navbar.top"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <div class="header"> | |
| <div class="subTitle">org.apache.river.tool</div> | |
| <h2 title="Class ClassDep" class="title">Class ClassDep</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <ul class="inheritance"> | |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> | |
| <li> | |
| <ul class="inheritance"> | |
| <li>org.apache.river.tool.ClassDep</li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <hr> | |
| <br> | |
| <pre>public class <span class="typeNameLabel">ClassDep</span> | |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> | |
| <div class="block">Tool used to analyze a set of classes and determine on what other classes | |
| they directly or indirectly depend. Typically this tool is used to | |
| compute the necessary and sufficient set of classes to include in a JAR | |
| file, for use in the class path of a client or service, or for use in the | |
| codebase of a client or service. The tool starts with a set of "root" | |
| classes and recursively computes a dependency graph, finding all of the | |
| classes referenced directly by the root classes, finding all of the | |
| classes referenced in turn by those classes, and so on, until no new | |
| classes are found or until classes that are not of interest are | |
| found. The normal output of the tool is a list of all of the classes in | |
| the dependency graph. The output from this command can be used as input | |
| to the <code>jar</code> tool, to create a JAR file containing precisely | |
| those classes. | |
| <p> | |
| The following items are discussed below: | |
| <ul> | |
| <li><a href="#running">Running the Tool</a> | |
| <li><a href="#processing">Processing Options</a> | |
| <li><a href="#output">Output Options and Arguments</a> | |
| <li><a href="#examples">Examples</a> | |
| </ul> | |
| <a name="running"></a> | |
| <h3>Running the Tool</h3> | |
| The command line for running the tool has the form: | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>input_classpath</b></var> <var><b>processing_options</b></var> <var><b>output_options</b></var> | |
| </pre></blockquote> | |
| <p> | |
| where <var><b>install_dir</b></var> is the directory where the Apache River release | |
| is installed. | |
| Note that the options for this tool can be specified in any order, and | |
| can be intermixed. | |
| <p> | |
| The <code>-cp</code> class path value, | |
| <var><b>input_classpath</b></var>, | |
| is an argument to the <code>ClassDep</code> tool itself and should | |
| include all of the classes that might need to be included in the | |
| dependency analysis. Typically this will include all of your application | |
| classes, classes from the Apache River release, and any other classes on which | |
| your classes might depend. It is safe to include more classes than are | |
| actually necessary (since the purpose of this tool is, after all, to | |
| determine which subset of these classes is actually necessary), but it is | |
| not necessary to include any classes that are part of the Java 2 SDK. | |
| The class path should be in the form of a list of directories or JAR | |
| files, delimited by a colon (":") on UNIX platforms and a semi-colon | |
| (";") on Microsoft Windows platforms. The order of locations in the path | |
| does not matter. If you use JAR files, any <code>Class-Path</code> | |
| manifest entries in those JAR files are ignored, so you must include the | |
| values of those manifest entries explicitly in the path, or errors may | |
| result. For example, if you include <code>jini-ext.jar</code> then you | |
| should explicitly include <code>jini-core.jar</code> as well, because | |
| <code>jini-core.jar</code> is in the <code>Class-Path</code> manifest | |
| entry of <code>jini-ext.jar</code>.</dd> | |
| <a name="processing"></a> | |
| <h3>Processing Options</h3> | |
| The root classes of the dependency graph can be specified by any | |
| combination of individual classes and directories of classes. Each of | |
| these options can be used any number of times, and are illustrated in the | |
| <a href="#examples">Examples</a> section of this page. | |
| <p> | |
| In general, you only need to specify concrete classes as roots, not | |
| interface types. When analyzing classes for the class path of an | |
| application, you typically need to include the top-level class (the one | |
| with the <code>main</code> method). When analyzing classes for the | |
| codebase of a service, you typically need to include the top-level proxy | |
| classes used by the service, any trust verifier classes for those | |
| proxies, and any custom entry classes used by the service for lookup | |
| service attributes. Also when analyzing classes for the codebase of a | |
| service, if the service's proxy can return leases, registration objects, | |
| or other proxies, or if your service generates events, and if those | |
| objects are only referenced by interface type in the top-level proxy, not | |
| by concrete class, then you also need to include the concrete classes of | |
| those other objects. In all cases, you typically need to include any stub | |
| classes that you generated with the <code>rmic</code> tool. | |
| <p> | |
| <dl> | |
| <dt><b><var>class</var></b> | |
| <dd>This option specifies the fully qualified name of an individual class | |
| to include as a root of the dependency graph. This option can be | |
| specified zero or more times. Each class you specify with this option | |
| needs to be in a package that is defined to be "inside" the graph (as | |
| described further below).</dd> | |
| <p> | |
| <dt><b><var>directory</var></b> | |
| <dd>This option specifies the root directory of a tree of compiled class | |
| files, all of which are to be included as roots of the dependency | |
| graph. This option can be specified zero or more times. The directory | |
| must be one of the directories specified in | |
| <var><b>input_classpath</b></var>, | |
| or a subdirectory of one, and must contain at least one filename | |
| separator character. Each class in the tree needs to be in a package that | |
| is defined to be "inside" the graph (as described further below). | |
| <p> | |
| <dt><b><var>directory</var></b> | |
| <dd>This option specifies the root directory of a tree of compiled class | |
| files that are considered as root for the dependency checking. This option | |
| can be specified zero or more times. The actual behavior depends on whether | |
| the <code>-newdirbehavior</code> options is specified. The directory must | |
| contain at least one filename separator character and be one of the | |
| directories specified in <var><b>input_classpath</b></var>, or when the old | |
| behavior is effective it can be a subdirectory of one of the directories on | |
| the <var><b>input_classpath</b></var>. Each class in the tree needs to be in | |
| a package that is defined to be "inside" the graph (as described further | |
| below). | |
| <p> | |
| When the <code>-newdirbehavior</code> options is set the <code>-inroot</code> | |
| and <code>-outroot</code> options can be used to include/exclude particular | |
| subtrees from the potential set of roots. When the old behavior is effective | |
| all classes are considered as root, but can be excluded through the | |
| <code>-prune</code> option. | |
| <p> | |
| <dl> | |
| <dt><b><code>-inroot</code> <var>package-prefix</var></b> (only valid with | |
| <code>-newdirbehavior</code>) | |
| <dd>Specifies a package namespace to include when selecting roots from the | |
| directory trees. Any classes found in this package or a subpackage of it are | |
| considered as root for the dependency checking, unless they are explicitly | |
| excluded using <code>-out</code>, <code>-skip</code> or <code>-outroot</code> | |
| options. If not specified all found classes are considered roots. This option | |
| can be specified zero or more times. Note that the argument to | |
| <code>-inroot</code> is a package namespace (delimited by "."), not a | |
| directory.</dd> | |
| </dl> | |
| <p> | |
| <dl> | |
| <dt><b><code>-outroot</code> <var>package-prefix</var></b> (only valid with | |
| <code>-newdirbehavior</code>) | |
| <dd>Specifies a package namespace to exclude when selecting roots from the | |
| directory trees. Within the directory trees as specified by the | |
| <code>rootdir</code> element, any classes that are in the given package or a | |
| subpackage of it are not treated as roots. This option can be specified zero | |
| or more times. Note that the argument to <code>-outroot</code> is a package | |
| namespace (delimited by "."), not a directory.</dd> | |
| </dl> | |
| <p> | |
| <dl> | |
| <dt><b><code>-prune</code> <var>package-prefix</var></b> (old behavior only) | |
| <dd>Specifies a package namespace to exclude when selecting roots from | |
| directory trees. Within the directory trees, any classes that are in the | |
| given package or a subpackage of it are not treated as roots. Note that | |
| this option has <i>no</i> effect on whether the classes in question end | |
| up "inside" or "outside" the dependency graph (as defined further below); | |
| it simply controls their use as roots. This option can be specified zero | |
| or more times. Note that the argument to <code>-prune</code> is a package | |
| namespace (delimited by "."), not a directory.</dd> | |
| </dl> | |
| <p> | |
| The <code>-skip</code> option (described further below) can be used to | |
| exclude specific classes from the set of roots. | |
| </dd> | |
| </dl> | |
| <p> | |
| Starting with the root classes, a dependency graph is constructed by | |
| examining the compiled class file for a class, finding all of the classes | |
| it references, and then in turn examining those classes. The extent of | |
| the graph is determined by which packages are defined to be "inside" the | |
| graph and which are defined to be "outside" the graph. If a referenced | |
| class is in a package that is defined to be outside the graph, that class | |
| is not included in the graph, and none of classes that it references are | |
| examined. All of the root classes must be in packages that are defined to | |
| be "inside" the graph. | |
| <p> | |
| The inside and outside packages are specified by using the following | |
| options. Each of these options may be specified zero or more times. Some | |
| variations are illustrated in the <a href="#examples">Examples</a> section | |
| of this page. | |
| <p> | |
| <dl> | |
| <dt><b><code>-in</code> <var>package-prefix</var></b> | |
| <dd>Specifies a namespace of "inside" packages. Any classes in this | |
| package or a subpackage of it are included in the dependency graph (and | |
| hence are to be included in your JAR file), unless they are explicitly | |
| excluded using <code>-out</code> or <code>-skip</code> options. This | |
| option can be specified zero or more times. If no <code>-in</code> | |
| options are specified, the default is that all packages are considered to | |
| be inside packages. Note that the argument to <code>-in</code> is a | |
| namespace, so none of its subpackages need to be specified as an argument | |
| to <code>-in</code>. | |
| <p> | |
| If you use this option, you will likely need to use it multiple | |
| times. For example, if your application classes are in the | |
| <code>com.corp.foo</code> namespace, and you also use some classes in the | |
| <code>org.apache.river</code> and <code>net.jini</code> namespaces, then you | |
| might specify: | |
| <pre>-in com.corp.foo -in org.apache.river -in net.jini</pre> | |
| </dd> | |
| <p> | |
| <dt><b><code>-out</code> <var>package-prefix</var></b> | |
| <dd>Specifies a namespace of "outside" packages. Any classes in this | |
| package or a subpackage of it are excluded from the dependency graph (and | |
| hence are to be excluded from your JAR file). This option can be | |
| specified zero or more times. If you specify <code>-in</code> options, | |
| then each <code>-out</code> namespace should be a subspace of some | |
| <code>-in</code> namespace. Note that the argument to <code>-out</code> | |
| is a namespace, so none of its subpackages need to be specified as an | |
| argument to <code>-out</code>. | |
| <p> | |
| If you use this option, you will likely need to use it multiple | |
| times. For example, if you do not specify any <code>-in</code> options, | |
| then all packages are considered inside the graph, including packages | |
| defined in the Java 2 SDK that you typically want to exclude, so you | |
| might exclude them by specifying: | |
| <pre>-out java -out javax</pre> | |
| As another example, if you have specified <code>-in com.corp.foo</code> | |
| but you don't want to include any of the classes in the | |
| <code>com.corp.foo.test</code> or <code>com.corp.foo.qa</code> namespaces | |
| in the dependency graph, then you would specify: | |
| <pre>-out com.corp.foo.test -out com.corp.foo.qa</pre> | |
| </dd> | |
| <p> | |
| <dt><b><code>-skip</code> <var>class</var></b> | |
| <dd>Specifies the fully qualified name of a specific class to exclude | |
| from the dependency graph. This option allows an individual class to be | |
| considered "outside" without requiring the entire package it is defined | |
| in to be considered outside. This option can be specified zero or more | |
| times. | |
| </dd> | |
| <p> | |
| <dt><b><code>-outer</code></b> | |
| <dd>By default, if a static nested class is included in the dependency | |
| graph, all references from that static nested class to its immediate | |
| lexically enclosing class are ignored (except when the static nested class | |
| extends its outer class), to avoid inadvertent inclusion of the enclosing | |
| class. (The default is chosen this way because the compiled class file of a | |
| static nested class always contains a reference to the immediate lexically | |
| enclosing class.) This option causes all such references to be considered | |
| rather than ignored. Note that this option is needed very infrequently.</dd> | |
| </dl> | |
| <p> | |
| <dt><b><code>-newdirbehavior</code></b> | |
| <dd>This option causes the utility to select classes, to serve as root for | |
| the dependency checking, from the directory argument based on the | |
| <code>-inroot</code> and <code>-outroot</code> options specified. When | |
| this option is set subdirectories of the specified directory are no longer | |
| considered as root for finding classes. When this option is not set, the | |
| default, the utility maintains the old behavior with respect to the semantics | |
| for the directories passed in and the <code>-prune</code> option must be | |
| used. You are advised to set this option as there are some edge cases for | |
| which the old behavior won't work as expected, especially when no | |
| <code>-in</code> options are set.</dd> | |
| </dl> | |
| <a name="output"></a> | |
| <h3>Output Options and Arguments</h3> | |
| The following options and arguments determine the content and format of | |
| the output produced by this tool. These options do not affect the | |
| dependency graph computation, only the information displayed in the | |
| output as a result of the computation. Most of these options may be | |
| specified multiple times. Some variations are illustrated in the | |
| <a href="#examples">Examples</a> section of this page. | |
| <dl> | |
| <dt><b><code>-edges</code></b> | |
| <dd>By default, the classes which are included in the dependency graph | |
| are displayed in the output. This option specifies that instead, the | |
| classes which are excluded from the dependency graph, but which are | |
| directly referenced by classes in the dependency graph, should be | |
| displayed in the output. These classes form the outside "edges" of the | |
| dependency graph. | |
| <p> | |
| For example, you might exclude classes from the Java 2 SDK from the | |
| dependency graph because you don't want to include them in your JAR file, | |
| but you might be interested in knowing which classes from the Java 2 SDK | |
| are referenced directly by the classes in your JAR file. The | |
| <code>-edges</code> option can be used to display this information. | |
| </dd> | |
| <p> | |
| <dt><b><code>-show</code> <var>package-prefix</var></b> | |
| <dd>Displays the classes that are in the specified package or a | |
| subpackage of it. This option can be specified zero or more times. If no | |
| <code>-show</code> options are specified, the default is that all classes | |
| in the dependency graph are displayed (or all edge classes, if | |
| <code>-edges</code> is specified). Note that the argument to | |
| <code>-show</code> is a namespace, so none of its subpackages need to be | |
| specified as an argument to <code>-show</code>. | |
| <p> | |
| For example, to determine which classes from the Java 2 SDK your | |
| application depends on, you might not specify any <code>-in</code> | |
| options, but limit the output by specifying: | |
| <pre>-show java -show javax</pre></dd> | |
| <p> | |
| <dt><b><code>-hide</code> <var>package-prefix</var></b> | |
| <dd>Specifies a namespace of packages which should not be displayed. Any | |
| classes in this package or a subpackage of it are excluded from the | |
| output. This option can be specified zero or more times. If you specify | |
| <code>-show</code> options, then each <code>-hide</code> namespace should | |
| be a subspace of some <code>-show</code> namespace. Note that the | |
| argument to <code>-hide</code> is a namespace, so none of its subpackages | |
| need to be specified as an argument to <code>-hide</code>. | |
| <p> | |
| For example, to determine which non-core classes from the | |
| <code>net.jini</code> namespace you use, you might specify: | |
| <pre>-show net.jini -hide net.jini.core</pre></dd> | |
| <p> | |
| <dt><b><code>-files</code></b> | |
| <dd>By default, fully qualified class names are displayed, with package | |
| names delimited by ".". This option causes the output to be in filename | |
| format instead, with package names delimited by filename separators and | |
| with ".class" appended. For example, using this option on Microsoft | |
| Windows platforms would produce output in the form of | |
| <code>com\corp\foo\Bar.class</code> instead of | |
| <code>com.corp.foo.Bar</code>. This option should be used to generate | |
| output suitable as input to the <code>jar</code> tool. | |
| <p> | |
| For more information on the <code>jar</code> tool, see: | |
| <ul> | |
| <li><a href="http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/jar.html"> | |
| http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/jar.html</a> | |
| <li><a href="http://java.sun.com/j2se/1.4/docs/tooldocs/windows/jar.html"> | |
| http://java.sun.com/j2se/1.4/docs/tooldocs/windows/jar.html</a> | |
| <li><a href="http://java.sun.com/j2se/1.4/docs/guide/jar/jar.html"> | |
| http://java.sun.com/j2se/1.4/docs/guide/jar/jar.html</a> | |
| </ul> | |
| </dd> | |
| <p> | |
| <dt><b><code>-tell</code> <var>class</var></b> | |
| <dd>Specifies the fully qualified name of a class for which dependency | |
| information is desired. This option causes the tool to display | |
| information about every class in the dependency graph that references the | |
| specified class. This information is sent to the error stream of the | |
| tool, not to the normal output stream. This option can be specified zero | |
| or more times. If this option is used, all other output options are | |
| ignored, and the normal class output is not produced. This option is | |
| useful for debugging. | |
| </dd> | |
| </dl> | |
| <a name="examples"></a> | |
| <h3>Examples</h3> | |
| (The examples in this section assume you ran the Apache River release installer | |
| with an "Install Set" selection that created the top-level | |
| <code>classes</code> directory. Alternatively, if you have compiled from | |
| the source code, substitute <code>source/classes</code> for | |
| <code>classes</code> in the examples.) | |
| <p> | |
| The following example computes the classes required for a codebase JAR | |
| file, starting with a smart proxy class and a stub class as roots, and | |
| displays them in filename format. (A more complete example would include | |
| additional roots for leases, registrations, events, and lookup service | |
| attributes, and would exclude platform classes such as those in | |
| <code>jsk-platform.jar</code>.) | |
| <p> | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>install_dir</b></var>/classes \ | |
| org.apache.river.reggie.RegistrarProxy org.apache.river.reggie.RegistrarImpl_Stub \ | |
| -in org.apache.river -in net.jini \ | |
| -files | |
| </pre></blockquote> | |
| <p> | |
| The following example computes the classes required for a classpath JAR | |
| file, starting with all of the classes in a directory as roots, and | |
| displays them in class name format. (A more complete example would exclude | |
| platform classes such as those in <code>jsk-platform.jar</code>.) | |
| <p> | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>install_dir</b></var>/classes \ | |
| <var><b>install_dir</b></var>/classes/org/apache/river/reggie \ | |
| -in org.apache.river -in net.jini | |
| </pre></blockquote> | |
| <p> | |
| The following example computes the <code>org.apache.river</code> classes used | |
| by a service implementation, and displays the <code>net.jini</code> | |
| classes that are immediately referenced by those classes. | |
| <p> | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>install_dir</b></var>/classes \ | |
| org.apache.river.reggie.RegistrarImpl \ | |
| -in org.apache.river \ | |
| -edges \ | |
| -show net.jini | |
| </pre></blockquote> | |
| <p> | |
| The following example computes all of the classes used by a service | |
| implementation that are not part of the Java 2 SDK, and displays the | |
| classes that directly reference the class <code>java.awt.Image</code>. | |
| <p> | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>install_dir</b></var>/classes \ | |
| org.apache.river.reggie.RegistrarImpl \ | |
| -out java -out javax \ | |
| -tell java.awt.Image | |
| </pre></blockquote> | |
| <p> | |
| The following example computes all of the classes to include in | |
| <code>jini-ext.jar</code> and displays them in filename format. Note | |
| that both <code>-out</code> and <code>-prune</code> options are needed | |
| for the <code>net.jini.core</code> namespace; <code>-out</code> to | |
| exclude classes from the dependency graph, and <code>-prune</code> to | |
| prevent classes from being used as roots. | |
| <p> | |
| <blockquote><pre> | |
| java -jar <var><b>install_dir</b></var>/lib/classdep.jar \ | |
| -cp <var><b>install_dir</b></var>/classes \ | |
| -in net.jini -out net.jini.core -in org.apache.river \ | |
| <var><b>install_dir</b></var>/classes/net/jini -prune net.jini.core \ | |
| -files | |
| </pre></blockquote></div> | |
| <dl> | |
| <dt><span class="simpleTagLabel">Author:</span></dt> | |
| <dd>Sun Microsystems, Inc.</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="nested.class.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested Class Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> | |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Class and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private static class </code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.Compare.html" title="class in org.apache.river.tool">ClassDep.Compare</a></span></code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> | |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Field and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="../../../../org/apache/river/tool/classdepend/ClassDepend.html" title="class in org.apache.river.tool.classdepend">ClassDepend</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#cd">cd</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#classes">classes</a></span></code> | |
| <div class="block">Class set to look at for dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#classpath">classpath</a></span></code> | |
| <div class="block">Set of paths to find class definitions in order to determine | |
| dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#edges">edges</a></span></code> | |
| <div class="block">Flag to determine whether there is interest | |
| in dependencies that go outside the set of | |
| interested classes.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#failed">failed</a></span></code> | |
| <div class="block">Indicates whether a failure has been encountered during deep dependency | |
| checking.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#files">files</a></span></code> | |
| <div class="block">If true class names are printed using | |
| the system's File.separator, else the | |
| fully qualified class name is printed.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#hides">hides</a></span></code> | |
| <div class="block">Suppress display of found dependencies that are under | |
| the provided package prefixes subset.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#ignoreOuter">ignoreOuter</a></span></code> | |
| <div class="block">Static inner classes have a dependency on their outer | |
| parent class.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#inside">inside</a></span></code> | |
| <div class="block">Package set that we have interest to work in.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#insideRoots">insideRoots</a></span></code> | |
| <div class="block">Set of packages to include when classes are found through the specified | |
| root directories.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#newRootDirBehavior">newRootDirBehavior</a></span></code> | |
| <div class="block">Indicates whether the root directories specified for finding classes | |
| for dependency checking must be traversed in the 'old' way, or that the | |
| new behavior must be effective.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#outside">outside</a></span></code> | |
| <div class="block">Package set to not work with.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#outsideRoots">outsideRoots</a></span></code> | |
| <div class="block">Set of packages to exclude when classes are found through the specified | |
| root directories.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#prunes">prunes</a></span></code> | |
| <div class="block">Set of packages to skip over in the processing of dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private static boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#resinit">resinit</a></span></code> </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private static <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#resources">resources</a></span></code> </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#results">results</a></span></code> | |
| <div class="block">Container for found dependency classes.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#roots">roots</a></span></code> | |
| <div class="block">Set of directories to find dependencies in.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#shows">shows</a></span></code> | |
| <div class="block">Only display found dependencies that fall under the provided | |
| <code>roots</code> subset.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#skips">skips</a></span></code> | |
| <div class="block">Set of classes to skip over in the processing of dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#tells">tells</a></span></code> | |
| <div class="block">Given a specific fully qualified classes, what other classes | |
| in the roots list depend on it.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> | |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> | |
| <tr> | |
| <th class="colOne" scope="col">Constructor and Description</th> | |
| </tr> | |
| <tr class="altColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#ClassDep--">ClassDep</a></span>()</code> | |
| <div class="block">No argument constructor.</div> | |
| </td> | |
| </tr> | |
| <tr class="rowColor"> | |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#ClassDep-java.lang.String:A-">ClassDep</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] cmdLine)</code> | |
| <div class="block">Constructor that takes command line arguments and fills in the | |
| appropriate fields.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Summary</h3> | |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> | |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> | |
| <tr> | |
| <th class="colFirst" scope="col">Modifier and Type</th> | |
| <th class="colLast" scope="col">Method and Description</th> | |
| </tr> | |
| <tr id="i0" class="altColor"> | |
| <td class="colFirst"><code>private static void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#add-java.lang.String-java.util.ArrayList-">add</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> arg, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> elts)</code> | |
| <div class="block">Take the given argument and add it to the provided container.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addClasses-java.lang.String-">addClasses</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> | |
| <div class="block">Add an entry into the set of classes that | |
| dependencies are going to be computed on.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addClassesRecursively-java.util.List-">addClassesRecursively</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> list)</code> | |
| <div class="block">Add all classes in Packages and subpackages recursively by appending ** | |
| as per the syntax requirements of the ClassDepend API.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addHides-java.lang.String-">addHides</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the set of package prefixes that | |
| are to remain hidden from processing.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addInside-java.lang.String-">addInside</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the working set of package prefixes | |
| that will make up the working domain space.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addInsideRoot-java.lang.String-">addInsideRoot</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Adds an entry into the set of package prefixes for which classes found | |
| through the specified root directories will be considered for dependency | |
| generation.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addOutside-java.lang.String-">addOutside</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that will bypassed during dependency checking.</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addOutsideRoot-java.lang.String-">addOutsideRoot</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Adds an entry into the set of package prefixes for which classes found | |
| through the specified root directories, and that are part of the inside | |
| root namespace, will be skipped as part of the dependency generation.</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addPrune-java.lang.String-">addPrune</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that will be skipped as part of the dependency | |
| generation.</div> | |
| </td> | |
| </tr> | |
| <tr id="i9" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addRoots-java.lang.String-">addRoots</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootName)</code> | |
| <div class="block">Add an entry into the set of directories to | |
| look under for the classes that fall within | |
| the working domain space as defined by the | |
| intersection of the following sets: | |
| inside,outside,prune,show, and hide.</div> | |
| </td> | |
| </tr> | |
| <tr id="i10" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addShow-java.lang.String-">addShow</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that we want to display.</div> | |
| </td> | |
| </tr> | |
| <tr id="i11" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addSkip-java.lang.String-">addSkip</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</code> | |
| <div class="block">Add an entry into the set of classes that | |
| should be skipped during dependency generation.</div> | |
| </td> | |
| </tr> | |
| <tr id="i12" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#addTells-java.lang.String-">addTells</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</code> | |
| <div class="block">Add an entry in to the set of classes whose dependents | |
| that lie with the inside set are listed.</div> | |
| </td> | |
| </tr> | |
| <tr id="i13" class="rowColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#compute--">compute</a></span>()</code> | |
| <div class="block">Method that takes the user provided switches that | |
| logically define the domain in which to look for | |
| dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr id="i14" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#getFiles--">getFiles</a></span>()</code> | |
| <div class="block">If true classnames will be separated using | |
| File.separator, else it will use dots.</div> | |
| </td> | |
| </tr> | |
| <tr id="i15" class="rowColor"> | |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#getResults--">getResults</a></span>()</code> | |
| <div class="block">Accessor method for the found dependencies.</div> | |
| </td> | |
| </tr> | |
| <tr id="i16" class="altColor"> | |
| <td class="colFirst"><code>private static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#getString-java.lang.String-">getString</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> | |
| <div class="block">Get the strings from our resource localization bundle.</div> | |
| </td> | |
| </tr> | |
| <tr id="i17" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#hasFailed--">hasFailed</a></span>()</code> | |
| <div class="block">Indicates whether computing the dependent classes as result of the last | |
| call to <a href="../../../../org/apache/river/tool/ClassDep.html#compute--"><code>compute()</code></a> resulted in one or more failures.</div> | |
| </td> | |
| </tr> | |
| <tr id="i18" class="altColor"> | |
| <td class="colFirst"><code>static void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> | |
| <div class="block">Command line interface for generating the list of classes that | |
| a set of classes depends upon.</div> | |
| </td> | |
| </tr> | |
| <tr id="i19" class="rowColor"> | |
| <td class="colFirst"><code>private static void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#print-java.lang.String-java.lang.Object-">print</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> | |
| <div class="block">Print out string according to resourceBundle format.</div> | |
| </td> | |
| </tr> | |
| <tr id="i20" class="altColor"> | |
| <td class="colFirst"><code>private static void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#print-java.lang.String-java.lang.Object-java.lang.Object-">print</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val1, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val2)</code> | |
| <div class="block">Print out string according to resourceBundle format.</div> | |
| </td> | |
| </tr> | |
| <tr id="i21" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#setClassPath-java.lang.String-">setClassPath</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classpath)</code> | |
| <div class="block">Set the classpath to use for finding our class definitions.</div> | |
| </td> | |
| </tr> | |
| <tr id="i22" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#setEdges-boolean-">setEdges</a></span>(boolean edges)</code> | |
| <div class="block">Determines whether to include package references | |
| that lie outside the declared set of interest.</div> | |
| </td> | |
| </tr> | |
| <tr id="i23" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#setFiles-boolean-">setFiles</a></span>(boolean files)</code> | |
| <div class="block">Determines how to print out the fully qualified | |
| class names.</div> | |
| </td> | |
| </tr> | |
| <tr id="i24" class="altColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#setRootDirBehavior-boolean-">setRootDirBehavior</a></span>(boolean newBehavior)</code> | |
| <div class="block">Controls whether the behavior for finding class files in the specified | |
| directories, if any, must be based on the old behavior (the default) or | |
| the new behavior that solves some of the problems with the old behavior.</div> | |
| </td> | |
| </tr> | |
| <tr id="i25" class="rowColor"> | |
| <td class="colFirst"><code>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#setupOptions-java.lang.String:A-">setupOptions</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</code> | |
| <div class="block">Convenience method for initializing an instance with specific | |
| command line arguments.</div> | |
| </td> | |
| </tr> | |
| <tr id="i26" class="altColor"> | |
| <td class="colFirst"><code>private void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#traverse-java.lang.String-">traverse</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> | |
| <div class="block">Recursively traverse a given path, finding all the classes that | |
| make up the set to work with.</div> | |
| </td> | |
| </tr> | |
| <tr id="i27" class="rowColor"> | |
| <td class="colFirst"><code>private void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#traverse-java.lang.String-java.lang.String-">traverse</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootPath)</code> | |
| <div class="block">Recursively traverse a given path, finding all the classes that make up | |
| the set of classes to work with.</div> | |
| </td> | |
| </tr> | |
| <tr id="i28" class="altColor"> | |
| <td class="colFirst"><code>static void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/tool/ClassDep.html#usage--">usage</a></span>()</code> | |
| <div class="block">Print out the usage for this utility.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> | |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="field.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Detail</h3> | |
| <a name="cd"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>cd</h4> | |
| <pre>private <a href="../../../../org/apache/river/tool/classdepend/ClassDepend.html" title="class in org.apache.river.tool.classdepend">ClassDepend</a> cd</pre> | |
| </li> | |
| </ul> | |
| <a name="files"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>files</h4> | |
| <pre>private boolean files</pre> | |
| <div class="block">If true class names are printed using | |
| the system's File.separator, else the | |
| fully qualified class name is printed.</div> | |
| </li> | |
| </ul> | |
| <a name="classpath"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>classpath</h4> | |
| <pre>private <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classpath</pre> | |
| <div class="block">Set of paths to find class definitions in order to determine | |
| dependencies.</div> | |
| </li> | |
| </ul> | |
| <a name="edges"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>edges</h4> | |
| <pre>private boolean edges</pre> | |
| <div class="block">Flag to determine whether there is interest | |
| in dependencies that go outside the set of | |
| interested classes. If false then outside, | |
| references are ignored, if true they are noted. | |
| i.e, if looking only under <code>net.jini.core.lease</code> | |
| a reference to a class in <code>net.jini</code> is found it | |
| will be noted if the flag is set to true, else | |
| it will be ignored. <p> | |
| <b>Note:</b> these edge case dependencies must be | |
| included in the classpath in order to find their | |
| definitions.</div> | |
| </li> | |
| </ul> | |
| <a name="ignoreOuter"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ignoreOuter</h4> | |
| <pre>private boolean ignoreOuter</pre> | |
| <div class="block">Static inner classes have a dependency on their outer | |
| parent class. Because the parent class may be really | |
| big and may pull other classes along with it we allow the | |
| choice to ignore the parent or not. If the flag is set to | |
| true we pull in the parent class. If it is false we don't | |
| look at the parent. The default is is to not include the | |
| parent. <p> | |
| <b>Note:</b> This is an optimization for those who plan | |
| on doing work with the output of this utility. It does | |
| not impact this utility, but the work done on its | |
| generated output may have an impact. | |
| This will have to be implemented in ClassDepend note the above | |
| description conflicts with the variable name.</div> | |
| </li> | |
| </ul> | |
| <a name="inside"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>inside</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> inside</pre> | |
| <div class="block">Package set that we have interest to work in.</div> | |
| </li> | |
| </ul> | |
| <a name="outside"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>outside</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> outside</pre> | |
| <div class="block">Package set to not work with. This is useful if | |
| there is a subpackage that needs to be ignored.</div> | |
| </li> | |
| </ul> | |
| <a name="classes"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>classes</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> classes</pre> | |
| <div class="block">Class set to look at for dependencies. These are | |
| fully qualified names, ie, net.jini.core.lease.Lease. | |
| This is a subset of the values in | |
| <code>inside</code>.</div> | |
| </li> | |
| </ul> | |
| <a name="roots"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>roots</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> roots</pre> | |
| <div class="block">Set of directories to find dependencies in.</div> | |
| </li> | |
| </ul> | |
| <a name="prunes"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>prunes</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> prunes</pre> | |
| <div class="block">Set of packages to skip over in the processing of dependencies. | |
| This can be used in conjunction with <em>-out</em> option.</div> | |
| </li> | |
| </ul> | |
| <a name="newRootDirBehavior"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>newRootDirBehavior</h4> | |
| <pre>private boolean newRootDirBehavior</pre> | |
| <div class="block">Indicates whether the root directories specified for finding classes | |
| for dependency checking must be traversed in the 'old' way, or that the | |
| new behavior must be effective.</div> | |
| </li> | |
| </ul> | |
| <a name="insideRoots"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>insideRoots</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> insideRoots</pre> | |
| <div class="block">Set of packages to include when classes are found through the specified | |
| root directories.</div> | |
| </li> | |
| </ul> | |
| <a name="outsideRoots"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>outsideRoots</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> outsideRoots</pre> | |
| <div class="block">Set of packages to exclude when classes are found through the specified | |
| root directories.</div> | |
| </li> | |
| </ul> | |
| <a name="skips"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>skips</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> skips</pre> | |
| <div class="block">Set of classes to skip over in the processing of dependencies.</div> | |
| </li> | |
| </ul> | |
| <a name="tells"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>tells</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> tells</pre> | |
| <div class="block">Given a specific fully qualified classes, what other classes | |
| in the roots list depend on it. This is more for debugging | |
| purposes rather then normal day to day usage.</div> | |
| </li> | |
| </ul> | |
| <a name="shows"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>shows</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> shows</pre> | |
| <div class="block">Only display found dependencies that fall under the provided | |
| <code>roots</code> subset.</div> | |
| </li> | |
| </ul> | |
| <a name="hides"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hides</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> hides</pre> | |
| <div class="block">Suppress display of found dependencies that are under | |
| the provided package prefixes subset.</div> | |
| </li> | |
| </ul> | |
| <a name="results"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>results</h4> | |
| <pre>private final <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a> results</pre> | |
| <div class="block">Container for found dependency classes.</div> | |
| </li> | |
| </ul> | |
| <a name="failed"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>failed</h4> | |
| <pre>private boolean failed</pre> | |
| <div class="block">Indicates whether a failure has been encountered during deep dependency | |
| checking.</div> | |
| </li> | |
| </ul> | |
| <a name="resources"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>resources</h4> | |
| <pre>private static <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> resources</pre> | |
| </li> | |
| </ul> | |
| <a name="resinit"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>resinit</h4> | |
| <pre>private static boolean resinit</pre> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="constructor.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Constructor Detail</h3> | |
| <a name="ClassDep--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>ClassDep</h4> | |
| <pre>public ClassDep()</pre> | |
| <div class="block">No argument constructor. The user must fill in the | |
| appropriate fields prior to asking for the processing | |
| of dependencies.</div> | |
| </li> | |
| </ul> | |
| <a name="ClassDep-java.lang.String:A-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>ClassDep</h4> | |
| <pre>public ClassDep(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] cmdLine)</pre> | |
| <div class="block">Constructor that takes command line arguments and fills in the | |
| appropriate fields. See the description of this class | |
| for a list and description of the acceptable arguments.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>cmdLine</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="add-java.lang.String-java.util.ArrayList-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>add</h4> | |
| <pre>private static void add(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> arg, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</a> elts)</pre> | |
| <div class="block">Take the given argument and add it to the provided container. | |
| We make sure that each inserted package-prefix is unique. For | |
| example if we had the following packages: | |
| <ul> | |
| <li>a.b | |
| <li>a.bx | |
| <li>a.b.c | |
| </ul> | |
| Looking for <code>a.b</code> should not match | |
| <code>a.bx</code> and <code>a.b</code>, | |
| just <code>a.b</code>.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>arg</code> - the package-prefix in string form</dd> | |
| <dd><code>elts</code> - container to add elements to</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="traverse-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>traverse</h4> | |
| <pre>private void traverse(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> | |
| <div class="block">Recursively traverse a given path, finding all the classes that | |
| make up the set to work with. We take into account skips, | |
| prunes, and out sets defined. | |
| <p> | |
| This implementation is here to maintain the old behavior with regard | |
| to how root directories were interpreted.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>path</code> - path to traverse down from</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="traverse-java.lang.String-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>traverse</h4> | |
| <pre>private void traverse(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootPath)</pre> | |
| <div class="block">Recursively traverse a given path, finding all the classes that make up | |
| the set of classes to work with. We take into account inroot and outroot | |
| sets, skips, and the in and out sets defined.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>path</code> - path to traverse down from</dd> | |
| <dd><code>rootPath</code> - path to the directory that serves as the root for the | |
| class files found, any path component below the root is part of | |
| the full qualified name of the class</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="compute--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>compute</h4> | |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] compute()</pre> | |
| <div class="block">Method that takes the user provided switches that | |
| logically define the domain in which to look for | |
| dependencies. | |
| <p> | |
| Whether a failure has occurred during computing the dependent classes | |
| can be found out with a call to <a href="../../../../org/apache/river/tool/ClassDep.html#hasFailed--"><code>hasFailed()</code></a>.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>array containing the dependent classes found in the format as | |
| specified by the options passed in</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addClassesRecursively-java.util.List-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addClassesRecursively</h4> | |
| <pre>private <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> addClassesRecursively(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a> list)</pre> | |
| <div class="block">Add all classes in Packages and subpackages recursively by appending ** | |
| as per the syntax requirements of the ClassDepend API.</div> | |
| </li> | |
| </ul> | |
| <a name="usage--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>usage</h4> | |
| <pre>public static void usage()</pre> | |
| <div class="block">Print out the usage for this utility.</div> | |
| </li> | |
| </ul> | |
| <a name="setClassPath-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setClassPath</h4> | |
| <pre>public void setClassPath(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> classpath)</pre> | |
| <div class="block">Set the classpath to use for finding our class definitions.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>classpath</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setFiles-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setFiles</h4> | |
| <pre>public void setFiles(boolean files)</pre> | |
| <div class="block">Determines how to print out the fully qualified | |
| class names. If <code>true</code> it will use | |
| <code>File.separator</code>, else <code>.</code>'s | |
| will be used. | |
| If not set the default is <code>false</code>.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>files</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addHides-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addHides</h4> | |
| <pre>public void addHides(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the set of package prefixes that | |
| are to remain hidden from processing.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addInside-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addInside</h4> | |
| <pre>public void addInside(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the working set of package prefixes | |
| that will make up the working domain space.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setEdges-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setEdges</h4> | |
| <pre>public void setEdges(boolean edges)</pre> | |
| <div class="block">Determines whether to include package references | |
| that lie outside the declared set of interest. | |
| <p> | |
| If true edges will be processed as well, else | |
| they will be ignored. If not set the default | |
| will be <code>false</code>. | |
| <p> | |
| <b>Note:</b> These edge classes must included | |
| in the classpath for this utility.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>edges</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addOutside-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addOutside</h4> | |
| <pre>public void addOutside(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that will bypassed during dependency checking. | |
| These entries should be subsets of the contents | |
| on the inside set.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addPrune-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addPrune</h4> | |
| <pre>public void addPrune(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that will be skipped as part of the dependency | |
| generation. | |
| <p> | |
| This method has no impact if the new behavior is effective for the | |
| interpretation of the root directories for finding class files to | |
| include for dependency checking.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setRootDirBehavior-boolean-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setRootDirBehavior</h4> | |
| <pre>public void setRootDirBehavior(boolean newBehavior)</pre> | |
| <div class="block">Controls whether the behavior for finding class files in the specified | |
| directories, if any, must be based on the old behavior (the default) or | |
| the new behavior that solves some of the problems with the old behavior.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>newBehavior</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addInsideRoot-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addInsideRoot</h4> | |
| <pre>public void addInsideRoot(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Adds an entry into the set of package prefixes for which classes found | |
| through the specified root directories will be considered for dependency | |
| generation. | |
| <p> | |
| Adding entries without a call to <a href="../../../../org/apache/river/tool/ClassDep.html#setRootDirBehavior-boolean-"><code>setRootDirBehavior(boolean)</code></a> | |
| with <code>true</code> as the argument will cause <a href="../../../../org/apache/river/tool/ClassDep.html#compute--"><code>compute()</code></a> to | |
| fail.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addOutsideRoot-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addOutsideRoot</h4> | |
| <pre>public void addOutsideRoot(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Adds an entry into the set of package prefixes for which classes found | |
| through the specified root directories, and that are part of the inside | |
| root namespace, will be skipped as part of the dependency generation. | |
| <p> | |
| Adding entries without a call to <a href="../../../../org/apache/river/tool/ClassDep.html#setRootDirBehavior-boolean-"><code>setRootDirBehavior(boolean)</code></a> | |
| with <code>true</code> as the argument will cause <a href="../../../../org/apache/river/tool/ClassDep.html#compute--"><code>compute()</code></a> to | |
| fail.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addShow-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addShow</h4> | |
| <pre>public void addShow(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the set of package prefixes | |
| that we want to display. | |
| This applies only to the final output, so this | |
| set should be a subset of the inside set with | |
| edges, if that was indicated.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addSkip-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addSkip</h4> | |
| <pre>public void addSkip(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> packagePrefix)</pre> | |
| <div class="block">Add an entry into the set of classes that | |
| should be skipped during dependency generation.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>packagePrefix</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addTells-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addTells</h4> | |
| <pre>public void addTells(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</pre> | |
| <div class="block">Add an entry in to the set of classes whose dependents | |
| that lie with the inside set are listed. This in | |
| the converse of the rest of the utility and is meant | |
| more for debugging purposes.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>className</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addRoots-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addRoots</h4> | |
| <pre>public void addRoots(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> rootName)</pre> | |
| <div class="block">Add an entry into the set of directories to | |
| look under for the classes that fall within | |
| the working domain space as defined by the | |
| intersection of the following sets: | |
| inside,outside,prune,show, and hide.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>rootName</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="addClasses-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>addClasses</h4> | |
| <pre>public void addClasses(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> className)</pre> | |
| <div class="block">Add an entry into the set of classes that | |
| dependencies are going to be computed on.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>className</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getFiles--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getFiles</h4> | |
| <pre>public boolean getFiles()</pre> | |
| <div class="block">If true classnames will be separated using | |
| File.separator, else it will use dots.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true or false</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getResults--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getResults</h4> | |
| <pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getResults()</pre> | |
| <div class="block">Accessor method for the found dependencies.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>String[] dependencies</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="hasFailed--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>hasFailed</h4> | |
| <pre>public boolean hasFailed()</pre> | |
| <div class="block">Indicates whether computing the dependent classes as result of the last | |
| call to <a href="../../../../org/apache/river/tool/ClassDep.html#compute--"><code>compute()</code></a> resulted in one or more failures.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd><code>true</code> in case a failure has happened, such as a | |
| class not being found, <code>false</code> otherwise</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="setupOptions-java.lang.String:A-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>setupOptions</h4> | |
| <pre>public void setupOptions(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre> | |
| <div class="block">Convenience method for initializing an instance with specific | |
| command line arguments. See the description of this class | |
| for a list and description of the acceptable arguments.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>args</code> - </dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getString-java.lang.String-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getString</h4> | |
| <pre>private static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getString(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> | |
| <div class="block">Get the strings from our resource localization bundle.</div> | |
| </li> | |
| </ul> | |
| <a name="print-java.lang.String-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>print</h4> | |
| <pre>private static void print(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> | |
| <div class="block">Print out string according to resourceBundle format.</div> | |
| </li> | |
| </ul> | |
| <a name="print-java.lang.String-java.lang.Object-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>print</h4> | |
| <pre>private static void print(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val1, | |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val2)</pre> | |
| <div class="block">Print out string according to resourceBundle format.</div> | |
| </li> | |
| </ul> | |
| <a name="main-java.lang.String:A-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>main</h4> | |
| <pre>public static void main(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] args)</pre> | |
| <div class="block">Command line interface for generating the list of classes that | |
| a set of classes depends upon. See the description of this class | |
| for a list and description of the acceptable arguments.</div> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <div class="bottomNav"><a name="navbar.bottom"> | |
| <!-- --> | |
| </a> | |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> | |
| <a name="navbar.bottom.firstrow"> | |
| <!-- --> | |
| </a> | |
| <ul class="navList" title="Navigation"> | |
| <li><a href="../../../../overview-summary.html">Overview</a></li> | |
| <li><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/ClassDep.html">Use</a></li> | |
| <li><a href="package-tree.html">Tree</a></li> | |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> | |
| <li><a href="../../../../index-all.html">Index</a></li> | |
| <li><a href="../../../../help-doc.html">Help</a></li> | |
| </ul> | |
| </div> | |
| <div class="subNav"> | |
| <ul class="navList"> | |
| <li><a href="../../../../org/apache/river/tool/CheckSer.html" title="class in org.apache.river.tool"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/tool/ClassDep.Compare.html" title="class in org.apache.river.tool"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/tool/ClassDep.html" target="_top">Frames</a></li> | |
| <li><a href="ClassDep.html" target="_top">No Frames</a></li> | |
| </ul> | |
| <ul class="navList" id="allclasses_navbar_bottom"> | |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> | |
| </ul> | |
| <div> | |
| <script type="text/javascript"><!-- | |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); | |
| if(window==top) { | |
| allClassesLink.style.display = "block"; | |
| } | |
| else { | |
| allClassesLink.style.display = "none"; | |
| } | |
| //--> | |
| </script> | |
| </div> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </li> | |
| <li><a href="#constructor.summary">Constr</a> | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li><a href="#field.detail">Field</a> | </li> | |
| <li><a href="#constructor.detail">Constr</a> | </li> | |
| <li><a href="#method.detail">Method</a></li> | |
| </ul> | |
| </div> | |
| <a name="skip.navbar.bottom"> | |
| <!-- --> | |
| </a></div> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <p class="legalCopy"><small>Copyright 2007-2013, multiple authors.<br>Licensed under the <a href=http://www.apache.org/licenses/LICENSE-2.0 target=child >Apache License, Version 2.0</a>, see the <a href=../../../../doc-files/NOTICE target=child >NOTICE</a> file for attributions.</small></p> | |
| </body> | |
| </html> |