blob: 67d4475ad00332b9bac13464eea0b59452dbfcaa [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>ObjectType (Apache Geode 1.15.0)</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="ObjectType (Apache Geode 1.15.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/cache/query/types/MapType.html" title="interface in org.apache.geode.cache.query.types"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/geode/cache/query/types/StructType.html" title="interface in org.apache.geode.cache.query.types"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/geode/cache/query/types/ObjectType.html" target="_top">Frames</a></li>
<li><a href="ObjectType.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.cache.query.types</div>
<h2 title="Interface ObjectType" class="title">Interface ObjectType</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a>, <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/query/types/CollectionType.html" title="interface in org.apache.geode.cache.query.types">CollectionType</a>, <a href="../../../../../../org/apache/geode/cache/query/types/MapType.html" title="interface in org.apache.geode.cache.query.types">MapType</a>, <a href="../../../../../../org/apache/geode/cache/query/types/StructType.html" title="interface in org.apache.geode.cache.query.types">StructType</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ObjectType</span>
extends <a href="../../../../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a></pre>
<div class="block">An ObjectType represents the type of an object in a query. An ObjectType is similar to a Class,
except unlike a Class it can be extended to add more information such as a subtype for collection
Classes, a key type for a map class, or a field information for structs.
Note that multiple instances of are allowed of the same type, so ObjectTypes should always be
compared using equals.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>GemFire 4.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/geode/cache/query/types/StructType.html" title="interface in org.apache.geode.cache.query.types"><code>StructType</code></a>,
<a href="../../../../../../org/apache/geode/cache/query/types/CollectionType.html" title="interface in org.apache.geode.cache.query.types"><code>CollectionType</code></a>,
<a href="../../../../../../org/apache/geode/cache/query/types/MapType.html" title="interface in org.apache.geode.cache.query.types"><code>MapType</code></a></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.apache.geode.DataSerializable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.geode.<a href="../../../../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a></h3>
<code><a href="../../../../../../org/apache/geode/DataSerializable.Replaceable.html" title="interface in org.apache.geode">DataSerializable.Replaceable</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="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="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></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><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/query/types/ObjectType.html#getSimpleClassName--">getSimpleClassName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/query/types/ObjectType.html#isCollectionType--">isCollectionType</a></span>()</code>
<div class="block">Return true if this is a CollectionType.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/query/types/ObjectType.html#isMapType--">isMapType</a></span>()</code>
<div class="block">Return true if this is a MapType</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/query/types/ObjectType.html#isStructType--">isStructType</a></span>()</code>
<div class="block">Return true if this is a StructType</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/geode/cache/query/types/ObjectType.html#resolveClass--">resolveClass</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.geode.DataSerializable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.geode.<a href="../../../../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a></h3>
<code><a href="../../../../../../org/apache/geode/DataSerializable.html#fromData-java.io.DataInput-">fromData</a>, <a href="../../../../../../org/apache/geode/DataSerializable.html#toData-java.io.DataOutput-">toData</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="isCollectionType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCollectionType</h4>
<pre>boolean&nbsp;isCollectionType()</pre>
<div class="block">Return true if this is a CollectionType. Note that MapTypes, Region types, and array types are
also considered CollectionTypes in the context of the query language and therefore return true
to this method.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this is a CollectionType</dd>
</dl>
</li>
</ul>
<a name="isMapType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isMapType</h4>
<pre>boolean&nbsp;isMapType()</pre>
<div class="block">Return true if this is a MapType</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this is a MapType</dd>
</dl>
</li>
</ul>
<a name="isStructType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isStructType</h4>
<pre>boolean&nbsp;isStructType()</pre>
<div class="block">Return true if this is a StructType</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether this is a StructType</dd>
</dl>
</li>
</ul>
<a name="getSimpleClassName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimpleClassName</h4>
<pre><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;getSimpleClassName()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the simple name for the class this resolves to without including the package</dd>
</dl>
</li>
</ul>
<a name="resolveClass--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolveClass</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&nbsp;resolveClass()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Class that this type corresponds to.</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>
<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/cache/query/types/MapType.html" title="interface in org.apache.geode.cache.query.types"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/geode/cache/query/types/StructType.html" title="interface in org.apache.geode.cache.query.types"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/geode/cache/query/types/ObjectType.html" target="_top">Frames</a></li>
<li><a href="ObjectType.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>