blob: 7659319ec112c2af29fe5d64a947b221d110b3e2 [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>IMerger (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="IMerger (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/IMerger.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/merge/IBatchMerger.html" title="interface in org.eclipse.emf.compare.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/emf/compare/merge/IMerger.html" target="_top">Frames</a></li>
<li><a href="IMerger.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><a href="#nested_class_summary">Nested</a>&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.merge</div>
<h2 title="Interface IMerger" class="title">Interface IMerger</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/eclipse/emf/compare/merge/IMerger2.html" title="interface in org.eclipse.emf.compare.merge">IMerger2</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/eclipse/emf/compare/merge/AbstractMerger.html" title="class in org.eclipse.emf.compare.merge">AbstractMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/AttributeChangeMerger.html" title="class in org.eclipse.emf.compare.merge">AttributeChangeMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/ConflictMerger.html" title="class in org.eclipse.emf.compare.merge">ConflictMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/FeatureMapChangeMerger.html" title="class in org.eclipse.emf.compare.merge">FeatureMapChangeMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/PseudoConflictMerger.html" title="class in org.eclipse.emf.compare.merge">PseudoConflictMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/ReferenceChangeMerger.html" title="class in org.eclipse.emf.compare.merge">ReferenceChangeMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/ResourceAttachmentChangeMerger.html" title="class in org.eclipse.emf.compare.merge">ResourceAttachmentChangeMerger</a>, <a href="../../../../../org/eclipse/emf/compare/merge/ResourceLocationChangeMerger.html" title="class in org.eclipse.emf.compare.merge">ResourceLocationChangeMerger</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IMerger</span></pre>
<div class="block">Mergers are used by EMF Compare to merge specific differences from one side to the other. A number of
default mergers are provided by EMF Compare, but they can be sub-classed and extended by clients through
the extension point "org.eclipse.emf.compare.ide.mergerExtension".
<p>
Clients are encouraged to subclass AbstractMerger instead of implementing IMerger so that they can benefit
from a maximum of the common procedures.
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</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="overviewSummary" 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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a></strong></code>
<div class="block">This will hold all registered mergers.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.RegistryImpl.html" title="class in org.eclipse.emf.compare.merge">IMerger.RegistryImpl</a></strong></code>
<div class="block">A default implementation of an <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge"><code>IMerger.Registry</code></a>.</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/merge/IMerger.html#copyLeftToRight(org.eclipse.emf.compare.Diff,%20org.eclipse.emf.common.util.Monitor)">copyLeftToRight</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/Monitor.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">Monitor</a>&nbsp;monitor)</code>
<div class="block">Executes the copy from left to right.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#copyRightToLeft(org.eclipse.emf.compare.Diff,%20org.eclipse.emf.common.util.Monitor)">copyRightToLeft</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/Monitor.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">Monitor</a>&nbsp;monitor)</code>
<div class="block">Executes the copy from right to left.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#getRanking()">getRanking</a></strong>()</code>
<div class="block">Returns the ranking of this merger.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#getRegistry()">getRegistry</a></strong>()</code>
<div class="block">Get the registry.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#isMergerFor(org.eclipse.emf.compare.Diff)">isMergerFor</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target)</code>
<div class="block">Check if the merger is a good candidate to merge the given difference.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#setRanking(int)">setRanking</a></strong>(int&nbsp;parseInt)</code>
<div class="block">Set the ranking of this merger.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#setRegistry(org.eclipse.emf.compare.merge.IMerger.Registry)">setRegistry</a></strong>(<a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a>&nbsp;registry)</code>
<div class="block">Set the registry containing this merger.</div>
</td>
</tr>
</table>
</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="isMergerFor(org.eclipse.emf.compare.Diff)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMergerFor</h4>
<pre>boolean&nbsp;isMergerFor(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target)</pre>
<div class="block">Check if the merger is a good candidate to merge the given difference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The given target difference.</dd>
<dt><span class="strong">Returns:</span></dt><dd>True if it is the good candidate, false otherwise.</dd></dl>
</li>
</ul>
<a name="getRanking()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRanking</h4>
<pre>int&nbsp;getRanking()</pre>
<div class="block">Returns the ranking of this merger.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ranking.</dd></dl>
</li>
</ul>
<a name="setRanking(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRanking</h4>
<pre>void&nbsp;setRanking(int&nbsp;parseInt)</pre>
<div class="block">Set the ranking of this merger.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parseInt</code> - The ranking.</dd></dl>
</li>
</ul>
<a name="copyRightToLeft(org.eclipse.emf.compare.Diff, org.eclipse.emf.common.util.Monitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyRightToLeft</h4>
<pre>void&nbsp;copyRightToLeft(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/Monitor.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">Monitor</a>&nbsp;monitor)</pre>
<div class="block">Executes the copy from right to left.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The difference to handle.</dd><dd><code>monitor</code> - Monitor.</dd></dl>
</li>
</ul>
<a name="copyLeftToRight(org.eclipse.emf.compare.Diff, org.eclipse.emf.common.util.Monitor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyLeftToRight</h4>
<pre>void&nbsp;copyLeftToRight(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
<a href="http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/org/eclipse/emf/common/util/Monitor.html?is-external=true" title="class or interface in org.eclipse.emf.common.util">Monitor</a>&nbsp;monitor)</pre>
<div class="block">Executes the copy from left to right.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The difference to handle.</dd><dd><code>monitor</code> - Monitor.</dd></dl>
</li>
</ul>
<a name="setRegistry(org.eclipse.emf.compare.merge.IMerger.Registry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRegistry</h4>
<pre>void&nbsp;setRegistry(<a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a>&nbsp;registry)</pre>
<div class="block">Set the registry containing this merger.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>registry</code> - The merger registry.</dd></dl>
</li>
</ul>
<a name="getRegistry()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRegistry</h4>
<pre><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a>&nbsp;getRegistry()</pre>
<div class="block">Get the registry.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The registry.</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/IMerger.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/merge/IBatchMerger.html" title="interface in org.eclipse.emf.compare.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/emf/compare/merge/IMerger.html" target="_top">Frames</a></li>
<li><a href="IMerger.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><a href="#nested_class_summary">Nested</a>&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>