blob: e418377247427533fa81b53b8aab9ef28b94f358 [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 -->
<title>Identifiable (Apache Geode 1.15.1)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Identifiable (Apache Geode 1.15.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":17,"i1":17,"i2":6,"i3":17};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/lang/AttachAPINotFoundException.html" title="class in org.apache.geode.lang"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/lang/Identifiable.html" target="_top">Frames</a></li>
<li><a href="Identifiable.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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.apache.geode.lang</div>
<h2 title="Interface Identifiable" class="title">Interface Identifiable&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the class type of the identifier.</dd>
</dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute">Function</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/geode/management/configuration/AbstractConfiguration.html" title="class in org.apache.geode.management.configuration">AbstractConfiguration</a>, <a href="../../../../org/apache/geode/modules/util/BootstrappingFunction.html" title="class in org.apache.geode.modules.util">BootstrappingFunction</a>, <a href="../../../../org/apache/geode/cache/configuration/CacheConfig.AsyncEventQueue.html" title="class in org.apache.geode.cache.configuration">CacheConfig.AsyncEventQueue</a>, <a href="../../../../org/apache/geode/cache/configuration/CacheElement.html" title="class in org.apache.geode.cache.configuration">CacheElement</a>, <a href="../../../../org/apache/geode/management/cli/CliFunction.html" title="class in org.apache.geode.management.cli">CliFunction</a>, <a href="../../../../org/apache/geode/modules/util/CreateRegionFunction.html" title="class in org.apache.geode.modules.util">CreateRegionFunction</a>, <a href="../../../../org/apache/geode/management/configuration/Deployment.html" title="class in org.apache.geode.management.configuration">Deployment</a>, <a href="../../../../org/apache/geode/management/configuration/DiskStore.html" title="class in org.apache.geode.management.configuration">DiskStore</a>, <a href="../../../../org/apache/geode/cache/configuration/DiskStoreType.html" title="class in org.apache.geode.cache.configuration">DiskStoreType</a>, <a href="../../../../org/apache/geode/cache/execute/FunctionAdapter.html" title="class in org.apache.geode.cache.execute">FunctionAdapter</a>, <a href="../../../../org/apache/geode/management/configuration/GatewayReceiver.html" title="class in org.apache.geode.management.configuration">GatewayReceiver</a>, <a href="../../../../org/apache/geode/management/configuration/GroupableConfiguration.html" title="class in org.apache.geode.management.configuration">GroupableConfiguration</a>, <a href="../../../../org/apache/geode/management/configuration/Index.html" title="class in org.apache.geode.management.configuration">Index</a>, <a href="../../../../org/apache/geode/cache/lucene/management/configuration/Index.html" title="class in org.apache.geode.cache.lucene.management.configuration">Index</a>, <a href="../../../../org/apache/geode/cache/configuration/JndiBindingsType.JndiBinding.html" title="class in org.apache.geode.cache.configuration">JndiBindingsType.JndiBinding</a>, <a href="../../../../org/apache/geode/cache/configuration/JndiBindingsType.JndiBinding.ConfigProperty.html" title="class in org.apache.geode.cache.configuration">JndiBindingsType.JndiBinding.ConfigProperty</a>, <a href="../../../../org/apache/geode/management/configuration/Member.html" title="class in org.apache.geode.management.configuration">Member</a>, <a href="../../../../org/apache/geode/management/runtime/MemberInformation.html" title="class in org.apache.geode.management.runtime">MemberInformation</a>, <a href="../../../../org/apache/geode/management/configuration/Pdx.html" title="class in org.apache.geode.management.configuration">Pdx</a>, <a href="../../../../org/apache/geode/cache/query/management/configuration/QueryConfigService.html" title="class in org.apache.geode.cache.query.management.configuration">QueryConfigService</a>, <a href="../../../../org/apache/geode/management/configuration/Region.html" title="class in org.apache.geode.management.configuration">Region</a>, <a href="../../../../org/apache/geode/cache/configuration/RegionConfig.html" title="class in org.apache.geode.cache.configuration">RegionConfig</a>, <a href="../../../../org/apache/geode/cache/configuration/RegionConfig.Index.html" title="class in org.apache.geode.cache.configuration">RegionConfig.Index</a>, <a href="../../../../org/apache/geode/modules/util/RegionSizeFunction.html" title="class in org.apache.geode.modules.util">RegionSizeFunction</a>, <a href="../../../../org/apache/geode/modules/util/TouchPartitionedRegionEntriesFunction.html" title="class in org.apache.geode.modules.util">TouchPartitionedRegionEntriesFunction</a>, <a href="../../../../org/apache/geode/modules/util/TouchReplicatedRegionEntriesFunction.html" title="class in org.apache.geode.modules.util">TouchReplicatedRegionEntriesFunction</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Identifiable&lt;T extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;T&gt;&gt;</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">The Identifiable interface defines a contract for classes whose Object instances can be uniquely
identified relative to other Object instances within the same class type hierarchy.
<p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 7.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a></dd>
</dl>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static &lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;<br>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/lang/Identifiable.html#exists-java.util.List-java.lang.String-">exists</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/lang/Identifiable.html#find-java.util.List-java.lang.String-">find</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/geode/lang/Identifiable.html" title="type parameter in Identifiable">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/lang/Identifiable.html#getId--">getId</a></span>()</code>
<div class="block">Gets the identifier uniquely identifying this Object instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;<br>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/lang/Identifiable.html#remove-java.util.List-java.lang.String-">remove</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</code>&nbsp;</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="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><a href="../../../../org/apache/geode/lang/Identifiable.html" title="type parameter in Identifiable">T</a>&nbsp;getId()</pre>
<div class="block">Gets the identifier uniquely identifying this Object instance.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an identifier uniquely identifying this Object.</dd>
</dl>
</li>
</ul>
<a name="exists-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>exists</h4>
<pre>static&nbsp;&lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;&nbsp;boolean&nbsp;exists(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
</li>
</ul>
<a name="find-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>find</h4>
<pre>static&nbsp;&lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;&nbsp;T&nbsp;find(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
</li>
</ul>
<a name="remove-java.util.List-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>remove</h4>
<pre>static&nbsp;&lt;T extends <a href="../../../../org/apache/geode/lang/Identifiable.html" title="interface in org.apache.geode.lang">Identifiable</a>&gt;&nbsp;void&nbsp;remove(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;id)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/geode/lang/AttachAPINotFoundException.html" title="class in org.apache.geode.lang"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/geode/lang/Identifiable.html" target="_top">Frames</a></li>
<li><a href="Identifiable.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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 ======= -->
</body>
</html>