blob: e4a41a0d021ddb035c9a824c01a516b212a8898b [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>IMerger2 (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="IMerger2 (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/IMerger2.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/merge/IMerger.RegistryImpl.html" title="class in org.eclipse.emf.compare.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/emf/compare/merge/PseudoConflictMerger.html" title="class 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/IMerger2.html" target="_top">Frames</a></li>
<li><a href="IMerger2.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.merge</div>
<h2 title="Interface IMerger2" class="title">Interface IMerger2</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html" title="interface in org.eclipse.emf.compare.merge">IMerger</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">IMerger2</span>
extends <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html" title="interface in org.eclipse.emf.compare.merge">IMerger</a></pre>
<div class="block">This adds the ability for <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html" title="interface in org.eclipse.emf.compare.merge"><code>mergers</code></a> to define their own sub-set of "required" differences.
<p>
This set of differences is what will be used by the UI to highlight related differences, by the batch
merger to determine whether the diff can be merged beforehand (one of the related being in conflict will
prevent the merge as a whole), ...
</p>
<p>
The <a href="../../../../../org/eclipse/emf/compare/merge/AbstractMerger.html" title="class in org.eclipse.emf.compare.merge"><code>AbstractMerger</code></a> implements this and can be sub-classed instead when the default set of
requirements is enough.
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.2</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>
<ul class="blockList">
<li class="blockList"><a name="nested_classes_inherited_from_class_org.eclipse.emf.compare.merge.IMerger">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.emf.compare.merge.<a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html" title="interface in org.eclipse.emf.compare.merge">IMerger</a></h3>
<code><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.Registry.html" title="interface in org.eclipse.emf.compare.merge">IMerger.Registry</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.RegistryImpl.html" title="class in org.eclipse.emf.compare.merge">IMerger.RegistryImpl</a></code></li>
</ul>
</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://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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger2.html#getDirectMergeDependencies(org.eclipse.emf.compare.Diff,%20boolean)">getDirectMergeDependencies</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;mergeLeftToRight)</code>
<div class="block">Retrieves the set of <b>directly</b> required diffs in order to merge the current one.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger2.html#getDirectResultingMerges(org.eclipse.emf.compare.Diff,%20boolean)">getDirectResultingMerges</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
boolean&nbsp;mergeRightToLeft)</code>
<div class="block">Returns all differences that will be merged because of our merging the given <code>target</code>
difference.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/emf/compare/merge/IMerger2.html#getDirectResultingRejections(org.eclipse.emf.compare.Diff,%20boolean)">getDirectResultingRejections</a></strong>(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
boolean&nbsp;mergeRightToLeft)</code>
<div class="block">Returns the set of all differences that need to be rejected if <code>target</code> is merged in the
given direction.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.emf.compare.merge.IMerger">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.emf.compare.merge.<a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html" title="interface in org.eclipse.emf.compare.merge">IMerger</a></h3>
<code><a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#copyLeftToRight(org.eclipse.emf.compare.Diff,%20org.eclipse.emf.common.util.Monitor)">copyLeftToRight</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#copyRightToLeft(org.eclipse.emf.compare.Diff,%20org.eclipse.emf.common.util.Monitor)">copyRightToLeft</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#getRanking()">getRanking</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#getRegistry()">getRegistry</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#isMergerFor(org.eclipse.emf.compare.Diff)">isMergerFor</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#setRanking(int)">setRanking</a>, <a href="../../../../../org/eclipse/emf/compare/merge/IMerger.html#setRegistry(org.eclipse.emf.compare.merge.IMerger.Registry)">setRegistry</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="getDirectMergeDependencies(org.eclipse.emf.compare.Diff, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectMergeDependencies</h4>
<pre><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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;&nbsp;getDirectMergeDependencies(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;diff,
boolean&nbsp;mergeLeftToRight)</pre>
<div class="block">Retrieves the set of <b>directly</b> required diffs in order to merge the current one. This may
includes the diff's <a href="../../../../../org/eclipse/emf/compare/Diff.html#getRequires()"><code>requirements</code></a>, its <a href="../../../../../org/eclipse/emf/compare/Diff.html#getImpliedBy()"><code>implying
diff</code></a>, or any other diff that we need to merge <u>before</u> the given one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>diff</code> - The diff which direct requirements we need.</dd><dd><code>mergeLeftToRight</code> - The direction in which we're considering a merge.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The set of <b>directly</b> required diffs in order to merge the current one.</dd></dl>
</li>
</ul>
<a name="getDirectResultingMerges(org.eclipse.emf.compare.Diff, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirectResultingMerges</h4>
<pre><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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;&nbsp;getDirectResultingMerges(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
boolean&nbsp;mergeRightToLeft)</pre>
<div class="block">Returns all differences that will be merged because of our merging the given <code>target</code>
difference.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The difference we're considering merging.</dd><dd><code>mergeRightToLeft</code> - The direction in which we're considering a merge.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Set of all differences that will be merged because we've merged <code>target</code>.</dd></dl>
</li>
</ul>
<a name="getDirectResultingRejections(org.eclipse.emf.compare.Diff, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDirectResultingRejections</h4>
<pre><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/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;&nbsp;getDirectResultingRejections(<a href="../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;target,
boolean&nbsp;mergeRightToLeft)</pre>
<div class="block">Returns the set of all differences that need to be rejected if <code>target</code> is merged in the
given direction.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - The difference we're considering merging.</dd><dd><code>mergeRightToLeft</code> - The direction in which we're considering a merge.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The Set of all differences that will be rejected if we are to merge merged <code>target</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/IMerger2.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/merge/IMerger.RegistryImpl.html" title="class in org.eclipse.emf.compare.merge"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/eclipse/emf/compare/merge/PseudoConflictMerger.html" title="class 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/IMerger2.html" target="_top">Frames</a></li>
<li><a href="IMerger2.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>