blob: 7c34e7196c4738eaaeb7d586eff85c7571bf622e [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_75) on Mon May 18 03:56:40 EDT 2015 -->
<title>ReadOnlyGraph (EMF Compare API Specification)</title>
<meta name="date" content="2015-05-18">
<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="ReadOnlyGraph (EMF Compare API Specification)";
}
//-->
</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/ReadOnlyGraph.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201505180755</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/emf/compare/internal/utils/PruningIterator.html" title="interface in org.eclipse.emf.compare.internal.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/eclipse/emf/compare/internal/utils/SafeSubMonitor.html" title="class in org.eclipse.emf.compare.internal.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" target="_top">Frames</a></li>
<li><a href="ReadOnlyGraph.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>Constr&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>Constr&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">org.eclipse.emf.compare.internal.utils</div>
<h2 title="Class ReadOnlyGraph" class="title">Class ReadOnlyGraph&lt;E&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/8/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.eclipse.emf.compare.internal.utils.ReadOnlyGraph&lt;E&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - Kind of elements used as this graph's nodes.</dd></dl>
<hr>
<br>
<pre>public final class <span class="strong">ReadOnlyGraph&lt;E&gt;</span>
extends <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Read-only version of an already existing <a href="../../../../../../org/eclipse/emf/compare/internal/utils/Graph.html" title="class in org.eclipse.emf.compare.internal.utils"><code>Graph</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#contains(E)">contains</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</code>
<div class="block">Checks whether this graph already contains the given element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getDirectParents(E)">getDirectParents</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</code>
<div class="block">Returns the <u>direct</u> parents of the given <code>element</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getParentData(E)">getParentData</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</code>
<div class="block">Get the parent data of the given element.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getSubgraphContaining(E)">getSubgraphContaining</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</code>
<div class="block">Returns the set of all elements of the subgraph containing the given element.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getSubgraphContaining(E,%20com.google.common.collect.ImmutableSet)">getSubgraphContaining</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element,
com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;endPoints)</code>
<div class="block">Returns the set of all elements of the subgraph containing the given element and ending at the given
boundaries.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getTreeFrom(E)">getTreeFrom</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;root)</code>
<div class="block">Returns the tree starting from the given root element if it is contained in the graph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getTreeFrom(E,%20java.util.Set)">getTreeFrom</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;root,
<a href="http://download.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;endPoints)</code>
<div class="block">Returns the tree starting from the given root element and ending at the given boundaries..</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#hasChild(E,%20E)">hasChild</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;parent,
<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;potentialChild)</code>
<div class="block">Checks if the given element is a parent of the given potential child, directly or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="class in org.eclipse.emf.compare.internal.utils">ReadOnlyGraph</a>&lt;E&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#toReadOnlyGraph(org.eclipse.emf.compare.internal.utils.Graph)">toReadOnlyGraph</a></strong>(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/Graph.html" title="class in org.eclipse.emf.compare.internal.utils">Graph</a>&lt;E&gt;&nbsp;graph)</code>
<div class="block">Convert a graph to a read-only graph.</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&nbsp;java.lang.<a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/8/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://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toReadOnlyGraph(org.eclipse.emf.compare.internal.utils.Graph)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toReadOnlyGraph</h4>
<pre>public static&nbsp;&lt;E&gt;&nbsp;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="class in org.eclipse.emf.compare.internal.utils">ReadOnlyGraph</a>&lt;E&gt;&nbsp;toReadOnlyGraph(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/Graph.html" title="class in org.eclipse.emf.compare.internal.utils">Graph</a>&lt;E&gt;&nbsp;graph)</pre>
<div class="block">Convert a graph to a read-only graph.</div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - Kind of elements used as this graph's nodes.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>graph</code> - The writable graph to convert.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a read-only graph version of the given graph.</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a><a name="contains(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
<pre>public&nbsp;boolean&nbsp;contains(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</pre>
<div class="block">Checks whether this graph already contains the given element.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Element we need to check.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this graph already contains the given elment, <code>false</code>
otherwise.</dd></dl>
</li>
</ul>
<a name="hasChild(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="hasChild(E, E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasChild</h4>
<pre>public&nbsp;boolean&nbsp;hasChild(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;parent,
<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;potentialChild)</pre>
<div class="block">Checks if the given element is a parent of the given potential child, directly or not.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - Element that could be a parent of <code>potentialChild</code>.</dd><dd><code>potentialChild</code> - The potential child of <code>parent</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if <code>parent</code> is an ancestor of <code>potentialChild</code>.</dd></dl>
</li>
</ul>
<a name="getDirectParents(java.lang.Object)">
<!-- -->
</a><a name="getDirectParents(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectParents</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;getDirectParents(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</pre>
<div class="block">Returns the <u>direct</u> parents of the given <code>element</code>.
<p>
<b>Note</b> that the returned set is an immutable view over a sub-graph of this graph.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - The element which parents we seek.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An immutable set of <u>direct</u> parents for the given <code>element</code>.</dd></dl>
</li>
</ul>
<a name="getParentData(java.lang.Object)">
<!-- -->
</a><a name="getParentData(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentData</h4>
<pre>public&nbsp;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;getParentData(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</pre>
<div class="block">Get the parent data of the given element. If the given element has several parents, then this method
will return <code>null</code>. If the given element has no parents, then then this method will return
<code>null</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Element we need the parent data of.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A parent data of type <code>E</code> if this element has a parent data, <code>null</code>
otherwise.</dd></dl>
</li>
</ul>
<a name="getSubgraphContaining(java.lang.Object)">
<!-- -->
</a><a name="getSubgraphContaining(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubgraphContaining</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;getSubgraphContaining(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element)</pre>
<div class="block">Returns the set of all elements of the subgraph containing the given element.
<p>
<b>Note</b> that the returned set is an immutable view over a sub-graph of this graph.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Element we need the subgraph of.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An immutable set of all elements of the subgraph containing the given element, an empty
immutable set if that element is not present in this graph.</dd></dl>
</li>
</ul>
<a name="getSubgraphContaining(java.lang.Object,com.google.common.collect.ImmutableSet)">
<!-- -->
</a><a name="getSubgraphContaining(E, com.google.common.collect.ImmutableSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubgraphContaining</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;getSubgraphContaining(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;element,
com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;endPoints)</pre>
<div class="block">Returns the set of all elements of the subgraph containing the given element and ending at the given
boundaries.
<p>
<b>Note</b> that the returned set is an immutable view over a sub-graph of this graph.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - Element we need the subgraph of.</dd><dd><code>endPoints</code> - Boundaries of the needed subgraph.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An immutable set over all elements of the subgraph containing the given element, an immutable
empty set if that element is not present in this graph.</dd></dl>
</li>
</ul>
<a name="getTreeFrom(java.lang.Object)">
<!-- -->
</a><a name="getTreeFrom(E)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTreeFrom</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;getTreeFrom(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;root)</pre>
<div class="block">Returns the tree starting from the given root element if it is contained in the graph.
<p>
Contrarily to <a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html#getSubgraphContaining(E)"><code>getSubgraphContaining(Object)</code></a>, this will only iterate over the children (and
recursively) of the given node, without ever "going up" to parents of these children.
</p>
<p>
<b>Note</b> that the returned set is an immutable view over a sub-graph of this graph.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - The element we are to consider as the root of a tree.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The immutable tree starting from the given root element if it is contained in this graph, and
immutable empty set otherwise.</dd></dl>
</li>
</ul>
<a name="getTreeFrom(java.lang.Object,java.util.Set)">
<!-- -->
</a><a name="getTreeFrom(E, java.util.Set)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTreeFrom</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableSet&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;getTreeFrom(<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&nbsp;root,
<a href="http://download.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" title="type parameter in ReadOnlyGraph">E</a>&gt;&nbsp;endPoints)</pre>
<div class="block">Returns the tree starting from the given root element and ending at the given boundaries..
<p>
Contrarily to <code>#getSubgraphContaining(Object, Set)</code>, this will only iterate over the children
(and recursively) of the given node, without ever "going up" to parents of these children.
</p>
<p>
<b>Note</b> that the returned set is an immutable view over a sub-graph of this graph.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - The element we are to consider as the root of a tree.</dd><dd><code>endPoints</code> - Boundaries of the tree.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The immutable tree starting from the given root element if it is contained in this graph, and
immutable empty set otherwise.</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/ReadOnlyGraph.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><span style='font-size:small'><b>EMF Compare</b><br>3.2.0.201505180755</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/eclipse/emf/compare/internal/utils/PruningIterator.html" title="interface in org.eclipse.emf.compare.internal.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/eclipse/emf/compare/internal/utils/SafeSubMonitor.html" title="class in org.eclipse.emf.compare.internal.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/eclipse/emf/compare/internal/utils/ReadOnlyGraph.html" target="_top">Frames</a></li>
<li><a href="ReadOnlyGraph.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>Constr&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>Constr&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><br><span style='font-size:small;float:right'>Copyright (c) 2006, 2014 Obeo and others. All rights reserved.</span></small></p>
</body>
</html>