blob: 64cc04d1de90ade1b6d7ef35e340bd789cd1eb8f [file] [log] [blame]
<!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 (version 1.7.0-google-v5) on Tue Oct 15 12:35:26 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>TreeIterables.DistanceRecordingTreeViewer (TestKit 1.0-SNAPSHOT API)</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TreeIterables.DistanceRecordingTreeViewer (TestKit 1.0-SNAPSHOT API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/TreeIterables.DistanceRecordingTreeViewer.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="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.html" title="class in com.google.android.apps.common.testing.ui.espresso.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" target="_top">Frames</a></li>
<li><a href="TreeIterables.DistanceRecordingTreeViewer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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">com.google.android.apps.common.testing.ui.espresso.util</div>
<h2 title="Class TreeIterables.DistanceRecordingTreeViewer" class="title">Class TreeIterables.DistanceRecordingTreeViewer&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/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>com.google.android.apps.common.testing.ui.espresso.util.TreeIterables.DistanceRecordingTreeViewer&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables.TreeViewer</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.html" title="class in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables</a></dd>
</dl>
<hr>
<br>
<pre>static class <span class="strong">TreeIterables.DistanceRecordingTreeViewer&lt;T&gt;</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables.TreeViewer</a>&lt;T&gt;</pre>
<div class="block">Provides a tree view of items of instance T and records their distance from
a well known root.
It is assumed that this TreeViewer will only be called with nodes that it
has processed via its children method, or the root node itself. Otherwise it
will not be able to determine distance from the root and an exception will be thrown.
This class is stateful and only provides the correct distances after the underlying
tree has been iterated over.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html#TreeIterables.DistanceRecordingTreeViewer(T, com.google.android.apps.common.testing.ui.espresso.util.TreeIterables.TreeViewer)">TreeIterables.DistanceRecordingTreeViewer</a></strong>(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;root,
<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables.TreeViewer</a>&lt;<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&gt;&nbsp;delegateViewer)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html#children(T)">children</a></strong>(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;node)</code>
<div class="block">Returns a collection view of the children of this node.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html#getDistance(T)">getDistance</a></strong>(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;node)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TreeIterables.DistanceRecordingTreeViewer(java.lang.Object,com.google.android.apps.common.testing.ui.espresso.util.TreeIterables.TreeViewer)">
<!-- -->
</a><a name="TreeIterables.DistanceRecordingTreeViewer(T, com.google.android.apps.common.testing.ui.espresso.util.TreeIterables.TreeViewer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TreeIterables.DistanceRecordingTreeViewer</h4>
<pre>TreeIterables.DistanceRecordingTreeViewer(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;root,
<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables.TreeViewer</a>&lt;<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&gt;&nbsp;delegateViewer)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDistance(java.lang.Object)">
<!-- -->
</a><a name="getDistance(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistance</h4>
<pre>int&nbsp;getDistance(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;node)</pre>
</li>
</ul>
<a name="children(java.lang.Object)">
<!-- -->
</a><a name="children(T)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>children</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&gt;&nbsp;children(<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&nbsp;node)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html#children(T)">TreeIterables.TreeViewer</a></code></strong></div>
<div class="block">Returns a collection view of the children of this node.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html#children(T)">children</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util">TreeIterables.TreeViewer</a>&lt;<a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" title="type parameter in TreeIterables.DistanceRecordingTreeViewer">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/TreeIterables.DistanceRecordingTreeViewer.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="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.html" title="class in com.google.android.apps.common.testing.ui.espresso.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.TreeViewer.html" title="interface in com.google.android.apps.common.testing.ui.espresso.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../index.html?com/google/android/apps/common/testing/ui/espresso/util/TreeIterables.DistanceRecordingTreeViewer.html" target="_top">Frames</a></li>
<li><a href="TreeIterables.DistanceRecordingTreeViewer.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2013. All rights reserved.</small></p>
</body>
</html>