blob: 5005225b7bbe7465578f9a19112c1c7e66a2bfe9 [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:39 EDT 2015 -->
<title>IChangeFactory (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="IChangeFactory (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/IChangeFactory.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/postprocessor/factories/AbstractChangeFactory.html" title="class in org.eclipse.emf.compare.internal.postprocessor.factories"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html" target="_top">Frames</a></li>
<li><a href="IChangeFactory.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.postprocessor.factories</div>
<h2 title="Interface IChangeFactory" class="title">Interface IChangeFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/AbstractChangeFactory.html" title="class in org.eclipse.emf.compare.internal.postprocessor.factories">AbstractChangeFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IChangeFactory</span></pre>
<div class="block">An <a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html" title="interface in org.eclipse.emf.compare.internal.postprocessor.factories"><code>IChangeFactory</code></a> is a factory capable to create an <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a> from a <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a> if
and only if this factory can <a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#handles(org.eclipse.emf.compare.Diff)"><code>handle</code></a> the given <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a>.
<p>
A factory must be able to say in which parent an <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a> must be attached if it handles the
<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a> from which it has been <a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#create(org.eclipse.emf.compare.Diff)"><code>created</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><a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#create(org.eclipse.emf.compare.Diff)">create</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</code>
<div class="block">Creates and returns a <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a> from the given <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#fillRequiredDifferences(org.eclipse.emf.compare.Comparison,%20org.eclipse.emf.compare.Diff)">fillRequiredDifferences</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a>&nbsp;comparison,
<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;extension)</code>
<div class="block">Sets the required link of the difference extension created by the related factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <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/internal/postprocessor/factories/IChangeFactory.html#getExtensionKind()">getExtensionKind</a></strong>()</code>
<div class="block">Returns the kind of extension that this factory has to create.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/emf/compare/Match.html" title="interface in org.eclipse.emf.compare">Match</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#getParentMatch(org.eclipse.emf.compare.Diff)">getParentMatch</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</code>
<div class="block">Returns the match in which the difference will be added.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html#handles(org.eclipse.emf.compare.Diff)">handles</a></strong>(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</code>
<div class="block">Returns true if this factory handles the given kind of Diff, i.e., if it can create an <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a>.</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="getExtensionKind()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensionKind</h4>
<pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&gt;&nbsp;getExtensionKind()</pre>
<div class="block">Returns the kind of extension that this factory has to create.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The kind of extension.</dd></dl>
</li>
</ul>
<a name="handles(org.eclipse.emf.compare.Diff)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handles</h4>
<pre>boolean&nbsp;handles(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</pre>
<div class="block">Returns true if this factory handles the given kind of Diff, i.e., if it can create an <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a>.
<p>
<b>Performance note: </b> this method should return as quickly as possible as it will called on every
<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a> of the Comparison.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - the element to test</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this factory handles the given input, false otherwise.</dd></dl>
</li>
</ul>
<a name="create(org.eclipse.emf.compare.Diff)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre><a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;create(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</pre>
<div class="block">Creates and returns a <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>extension</code></a> from the given <a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare"><code>Diff</code></a>. The returned element MUST NOT
be added to its parent, it will be done by the post processor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - The input difference element.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The difference extension.</dd></dl>
</li>
</ul>
<a name="getParentMatch(org.eclipse.emf.compare.Diff)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentMatch</h4>
<pre><a href="../../../../../../../org/eclipse/emf/compare/Match.html" title="interface in org.eclipse.emf.compare">Match</a>&nbsp;getParentMatch(<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;input)</pre>
<div class="block">Returns the match in which the difference will be added.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - The input difference element.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The difference extension.</dd></dl>
</li>
</ul>
<a name="fillRequiredDifferences(org.eclipse.emf.compare.Comparison, org.eclipse.emf.compare.Diff)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fillRequiredDifferences</h4>
<pre>void&nbsp;fillRequiredDifferences(<a href="../../../../../../../org/eclipse/emf/compare/Comparison.html" title="interface in org.eclipse.emf.compare">Comparison</a>&nbsp;comparison,
<a href="../../../../../../../org/eclipse/emf/compare/Diff.html" title="interface in org.eclipse.emf.compare">Diff</a>&nbsp;extension)</pre>
<div class="block">Sets the required link of the difference extension created by the related factory.<br>
It has to be called when all the extensions are created.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparison</code> - The comparison.</dd><dd><code>extension</code> - The difference extension.</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/IChangeFactory.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/postprocessor/factories/AbstractChangeFactory.html" title="class in org.eclipse.emf.compare.internal.postprocessor.factories"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/internal/postprocessor/factories/IChangeFactory.html" target="_top">Frames</a></li>
<li><a href="IChangeFactory.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>