blob: fded70ef26382ba8005bb785d600cc1142027a52 [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:36 EDT 2015 -->
<title>IItemDescriptor (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="IItemDescriptor (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/IItemDescriptor.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/internal/extension/IEMFCompareBuilderConfigurator.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemRegistry.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" target="_top">Frames</a></li>
<li><a href="IItemDescriptor.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.rcp.internal.extension</div>
<h2 title="Interface IItemDescriptor" class="title">Interface IItemDescriptor&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - one of the item</dd></dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</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;T&gt;&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/impl/AbstractItemDescriptor.html" title="class in org.eclipse.emf.compare.rcp.internal.extension.impl">AbstractItemDescriptor</a>, <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">DifferenceGroupDescriptorWrapper</a>, <a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/impl/LazyItemDescriptor.html" title="class in org.eclipse.emf.compare.rcp.internal.extension.impl">LazyItemDescriptor</a>, <a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/match/MatchEngineFactoryDescriptor.html" title="class in org.eclipse.emf.compare.rcp.internal.match">MatchEngineFactoryDescriptor</a>, <a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/impl/WrapperItemDescriptor.html" title="class in org.eclipse.emf.compare.rcp.internal.extension.impl">WrapperItemDescriptor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">IItemDescriptor&lt;T&gt;</span>
extends <a href="http://download.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</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;T&gt;&gt;</pre>
<div class="block">An item descriptor.</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="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html#getDescription()">getDescription</a></strong>()</code>
<div class="block">The description of the item.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html#getID()">getID</a></strong>()</code>
<div class="block">Get a unique key identifying this item.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="type parameter in IItemDescriptor">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html#getItem()">getItem</a></strong>()</code>
<div class="block">Get an instance of an item.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html#getLabel()">getLabel</a></strong>()</code>
<div class="block">The label of the item.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html#getRank()">getRank</a></strong>()</code>
<div class="block">Rank of the item.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="http://download.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a></h3>
<code><a href="http://download.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</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="getLabel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabel</h4>
<pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLabel()</pre>
<div class="block">The label of the item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>label of the item</dd></dl>
</li>
</ul>
<a name="getDescription()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription()</pre>
<div class="block">The description of the item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>description of the item</dd></dl>
</li>
</ul>
<a name="getRank()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRank</h4>
<pre>int&nbsp;getRank()</pre>
<div class="block">Rank of the item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>rank</dd></dl>
</li>
</ul>
<a name="getID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre><a href="http://download.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getID()</pre>
<div class="block">Get a unique key identifying this item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a key</dd></dl>
</li>
</ul>
<a name="getItem()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getItem</h4>
<pre><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" title="type parameter in IItemDescriptor">T</a>&nbsp;getItem()</pre>
<div class="block">Get an instance of an item.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an instance of an item</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/IItemDescriptor.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/internal/extension/IEMFCompareBuilderConfigurator.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../org/eclipse/emf/compare/rcp/internal/extension/IItemRegistry.html" title="interface in org.eclipse.emf.compare.rcp.internal.extension"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/eclipse/emf/compare/rcp/internal/extension/IItemDescriptor.html" target="_top">Frames</a></li>
<li><a href="IItemDescriptor.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>