blob: d7e700105ddbfe45d5f36b3392a7e50a784578a0 [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:43 EDT 2015 -->
<title>DifferenceGroupManager (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="DifferenceGroupManager (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/DifferenceGroupManager.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/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupDescriptorWrapper.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.groups.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupProviderChange.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.groups.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html" target="_top">Frames</a></li>
<li><a href="DifferenceGroupManager.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.rcp.ui.internal.structuremergeviewer.groups.impl</div>
<h2 title="Class DifferenceGroupManager" class="title">Class DifferenceGroupManager</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.rcp.ui.internal.structuremergeviewer.groups.impl.DifferenceGroupManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DifferenceGroupManager</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 manager can be used to modify EMF Compare UI behavior regarding groups.
<p>
This manager can override the rank of groups. For example, it can be used to define a default group that
will be used by EMF Compare UI.
</p>
<p>
This manager can define a synchronization behavior between a user selection of group in EMF Compare UI and
the default group that is used by EMF Compare UI.
</p></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/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html#DifferenceGroupManager(org.osgi.service.prefs.Preferences,%20org.eclipse.emf.compare.rcp.internal.extension.IItemRegistry)">DifferenceGroupManager</a></strong>(org.osgi.service.prefs.Preferences&nbsp;preferences,
<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemRegistry.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemRegistry</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&nbsp;registry)</code>
<div class="block">Constructor.</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><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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html#getCurrentGroupRanking(boolean)">getCurrentGroupRanking</a></strong>(boolean&nbsp;isThreeWay)</code>
<div class="block">Gets the current group order.</div>
</td>
</tr>
<tr class="rowColor">
<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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html#getDefaultRankingConfiguration(boolean)">getDefaultRankingConfiguration</a></strong>(boolean&nbsp;isThreeWay)</code>
<div class="block">Gets the default groups order.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html#setCurrentGroupRanking(java.util.List,%20boolean)">setCurrentGroupRanking</a></strong>(<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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;&nbsp;descriptors,
boolean&nbsp;isThreeWay)</code>
<div class="block">Sets the ranking of Difference group provider.</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="DifferenceGroupManager(org.osgi.service.prefs.Preferences, org.eclipse.emf.compare.rcp.internal.extension.IItemRegistry)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DifferenceGroupManager</h4>
<pre>public&nbsp;DifferenceGroupManager(org.osgi.service.prefs.Preferences&nbsp;preferences,
<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemRegistry.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemRegistry</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&nbsp;registry)</pre>
<div class="block">Constructor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preferences</code> - Preferences holding preference values.</dd><dd><code>registry</code> - Registry of <code>IDifferenceGroupProvider.Descriptor</code>.</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="getCurrentGroupRanking(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentGroupRanking</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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;&nbsp;getCurrentGroupRanking(boolean&nbsp;isThreeWay)</pre>
<div class="block">Gets the current group order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isThreeWay</code> - True if three way comparison, false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Ordered <a href="http://download.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <code>IDifferenceGroupProvider.Descriptor</code>.</dd></dl>
</li>
</ul>
<a name="getDefaultRankingConfiguration(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultRankingConfiguration</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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;&nbsp;getDefaultRankingConfiguration(boolean&nbsp;isThreeWay)</pre>
<div class="block">Gets the default groups order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isThreeWay</code> - True if three way comparison, false otherwise.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Ordered <a href="http://download.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> of <code>IDifferenceGroupProvider.Descriptor</code>.</dd></dl>
</li>
</ul>
<a name="setCurrentGroupRanking(java.util.List, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCurrentGroupRanking</h4>
<pre>public&nbsp;void&nbsp;setCurrentGroupRanking(<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/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension">IItemDescriptor</a>&lt;<a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/structuremergeviewer/groups/IDifferenceGroupProvider.Descriptor.html" title="interface in org.eclipse.emf.compare.rcp.ui.structuremergeviewer.groups">IDifferenceGroupProvider.Descriptor</a>&gt;&gt;&nbsp;descriptors,
boolean&nbsp;isThreeWay)</pre>
<div class="block">Sets the ranking of Difference group provider.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>descriptors</code> - An ordered list of <a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><code>IItemDescriptor</code></a>.</dd><dd><code>isThreeWay</code> - True if three way comparison.</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/DifferenceGroupManager.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/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupDescriptorWrapper.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.groups.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../../../../org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupProviderChange.html" title="class in org.eclipse.emf.compare.rcp.ui.internal.structuremergeviewer.groups.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../../../../index.html?org/eclipse/emf/compare/rcp/ui/internal/structuremergeviewer/groups/impl/DifferenceGroupManager.html" target="_top">Frames</a></li>
<li><a href="DifferenceGroupManager.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>