blob: a665dfe9eb49e93a5b3e175768b1f87a5feae3e2 [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 Jun 08 05:48:08 EDT 2015 -->
<title>ModelResolverRegistry (EMF Compare API Specification)</title>
<meta name="date" content="2015-06-08">
<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="ModelResolverRegistry (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/ModelResolverRegistry.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.201506080946</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverDescriptor.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistryListener.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html" target="_top">Frames</a></li>
<li><a href="ModelResolverRegistry.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">org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry</div>
<h2 title="Class ModelResolverRegistry" class="title">Class ModelResolverRegistry</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.ide.ui.internal.logical.resolver.registry.ModelResolverRegistry</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">ModelResolverRegistry</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">This registry implements its own strategy to define the "best" resolver to use.</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="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html#ModelResolverRegistry()">ModelResolverRegistry</a></strong>()</code>
<div class="block">Initializes our registry.</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="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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html#clear()">clear</a></strong>()</code>
<div class="block">Clears out all registered resolvers from this registry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/logical/IModelResolver.html" title="interface in org.eclipse.emf.compare.ide.ui.logical">IModelResolver</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html#getBestResolverFor(org.eclipse.core.resources.IStorage)">getBestResolverFor</a></strong>(<a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/resources/IStorage.html?is-external=true" title="class or interface in org.eclipse.core.resources">IStorage</a>&nbsp;sourceStorage)</code>
<div class="block">Returns a <a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/logical/IModelResolver.html" title="interface in org.eclipse.emf.compare.ide.ui.logical"><code>IModelResolver</code></a> that handles the given IStorage.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverDescriptor.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry">ModelResolverDescriptor</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html#getRegisteredDescriptors()">getRegisteredDescriptors</a></strong>()</code>
<div class="block">Returns a view of the descriptors registered in this registry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html#isEnabled()">isEnabled</a></strong>()</code>
<div class="block">This can be used to check whether model resolution is currently enabled.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ModelResolverRegistry()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ModelResolverRegistry</h4>
<pre>public&nbsp;ModelResolverRegistry()</pre>
<div class="block">Initializes our registry.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preferenceStore</code> - Preference store this can query for resolver-related information.</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="getRegisteredDescriptors()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegisteredDescriptors</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverDescriptor.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry">ModelResolverDescriptor</a>&gt;&nbsp;getRegisteredDescriptors()</pre>
<div class="block">Returns a view of the descriptors registered in this registry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A view of the descriptors registered in this registry.</dd></dl>
</li>
</ul>
<a name="getBestResolverFor(org.eclipse.core.resources.IStorage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBestResolverFor</h4>
<pre>public&nbsp;<a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/logical/IModelResolver.html" title="interface in org.eclipse.emf.compare.ide.ui.logical">IModelResolver</a>&nbsp;getBestResolverFor(<a href="http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/resources/IStorage.html?is-external=true" title="class or interface in org.eclipse.core.resources">IStorage</a>&nbsp;sourceStorage)</pre>
<div class="block">Returns a <a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/logical/IModelResolver.html" title="interface in org.eclipse.emf.compare.ide.ui.logical"><code>IModelResolver</code></a> that handles the given IStorage.
<p>
This will iterate over all the registered resolvers, selecting the highest-ranking resolver that can
resolve the target models.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceStorage</code> - Source of the comparison</dd>
<dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/logical/IModelResolver.html" title="interface in org.eclipse.emf.compare.ide.ui.logical"><code>IModelResolver</code></a> that is able to handle the IStorage.</dd></dl>
</li>
</ul>
<a name="isEnabled()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnabled</h4>
<pre>public&nbsp;boolean&nbsp;isEnabled()</pre>
<div class="block">This can be used to check whether model resolution is currently enabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the model resolution is enabled, <code>false</code> otherwise.</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clear</h4>
<pre>public&nbsp;void&nbsp;clear()</pre>
<div class="block">Clears out all registered resolvers from this registry.</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><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/ModelResolverRegistry.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.201506080946</span></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverDescriptor.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistryListener.html" title="class in org.eclipse.emf.compare.ide.ui.internal.logical.resolver.registry"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/eclipse/emf/compare/ide/ui/internal/logical/resolver/registry/ModelResolverRegistry.html" target="_top">Frames</a></li>
<li><a href="ModelResolverRegistry.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><br><span style='font-size:small;float:right'>Copyright (c) 2006, 2014 Obeo and others. All rights reserved.</span></small></p>
</body>
</html>