<!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_45) on Thu Jan 09 22:45:26 GMT 2014 --> <title>RawType</title> <meta name="date" content="2014-01-09"> <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="RawType"; } //--> </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="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="../../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/persist/raw/RawType.html" target="_top">Frames</a></li> <li><a href="RawType.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: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </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">com.sleepycat.persist.raw</div> <h2 title="Interface RawType" class="title">Interface RawType</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../com/sleepycat/persist/impl/ComplexFormat.html" title="class in com.sleepycat.persist.impl">ComplexFormat</a>, <a href="../../../../com/sleepycat/persist/impl/CompositeKeyFormat.html" title="class in com.sleepycat.persist.impl">CompositeKeyFormat</a>, <a href="../../../../com/sleepycat/persist/impl/EnumFormat.html" title="class in com.sleepycat.persist.impl">EnumFormat</a>, <a href="../../../../com/sleepycat/persist/impl/Format.html" title="class in com.sleepycat.persist.impl">Format</a>, <a href="../../../../com/sleepycat/persist/impl/ObjectArrayFormat.html" title="class in com.sleepycat.persist.impl">ObjectArrayFormat</a>, <a href="../../../../com/sleepycat/persist/impl/PrimitiveArrayFormat.html" title="class in com.sleepycat.persist.impl">PrimitiveArrayFormat</a>, <a href="../../../../com/sleepycat/persist/impl/ProxiedFormat.html" title="class in com.sleepycat.persist.impl">ProxiedFormat</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.html" title="class in com.sleepycat.persist.impl">SimpleFormat</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FBigInt.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FBigInt</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FBool.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FBool</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FByte.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FByte</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FChar.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FChar</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FDate.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FDate</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FDouble.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FDouble</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FFloat.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FFloat</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FInt.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FInt</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FLong.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FLong</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FShort.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FShort</a>, <a href="../../../../com/sleepycat/persist/impl/SimpleFormat.FString.html" title="class in com.sleepycat.persist.impl">SimpleFormat.FString</a></dd> </dl> <hr> <br> <pre>public interface <span class="strong">RawType</span></pre> <div class="block">The type definition for a simple or complex persistent type, or an array of persistent types. <p><code>RawType</code> objects are thread-safe. Multiple threads may safely call the methods of a shared <code>RawType</code> object.</p></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"> </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="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getClassMetadata()">getClassMetadata</a></strong>()</code> <div class="block">Returns the original model class metadata used to create this class, or null if this is not a model class.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getClassName()">getClassName</a></strong>()</code> <div class="block">Returns the class name for this type in the format specified by <code>Class.getName()</code>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getComponentType()">getComponentType</a></strong>()</code> <div class="block">Returns the array component type, or null if this is not an array type.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getDimensions()">getDimensions</a></strong>()</code> <div class="block">Returns the number of array dimensions, or zero if this is not an array type.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getEntityMetadata()">getEntityMetadata</a></strong>()</code> <div class="block">Returns the original model entity metadata used to create this class, or null if this is not an entity class.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>java.util.List<java.lang.String></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getEnumConstants()">getEnumConstants</a></strong>()</code> <div class="block">Returns an unmodifiable list of the names of the enum instances, or null if this is not an enum type.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/raw/RawField.html" title="interface in com.sleepycat.persist.raw">RawField</a>></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getFields()">getFields</a></strong>()</code> <div class="block">Returns a map of field name to raw field for each non-static non-transient field declared in this class, or null if this is not a complex type (in other words, this is a simple type or an array type).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getId()">getId</a></strong>()</code> <div class="block">Returns the internal unique ID for this type.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getSuperType()">getSuperType</a></strong>()</code> <div class="block">Returns the type of the superclass, or null if the superclass is Object or this is not a complex type (in other words, this is a simple type or an array type).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#getVersion()">getVersion</a></strong>()</code> <div class="block">Returns the class version for this type.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#isArray()">isArray</a></strong>()</code> <div class="block">Returns whether this is an array type.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#isEnum()">isEnum</a></strong>()</code> <div class="block">Returns whether this is an enum type.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#isPrimitive()">isPrimitive</a></strong>()</code> <div class="block">Returns whether this type is a Java primitive: char, byte, short, int, long, float or double.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#isSimple()">isSimple</a></strong>()</code> <div class="block">Returns whether this is a <a href="../model/Entity.html#simpleTypes">simple type</a>: primitive, primitive wrapper, BigInteger, String or Date.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../com/sleepycat/persist/raw/RawType.html#toString()">toString</a></strong>()</code> <div class="block">Returns an XML representation of the raw type.</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="getClassName()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClassName</h4> <pre>java.lang.String getClassName()</pre> <div class="block">Returns the class name for this type in the format specified by <code>Class.getName()</code>. <p>If this class currently exists (has not been removed or renamed) then the class name may be passed to <code>Class.forName(java.lang.String)</code> to get the current <code>Class</code> object. However, if this raw type is not the current version of the class, this type information may differ from that of the current <code>Class</code>.</p></div> </li> </ul> <a name="getVersion()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getVersion</h4> <pre>int getVersion()</pre> <div class="block">Returns the class version for this type. For simple types, zero is always returned.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/sleepycat/persist/model/Entity.html#version()"><code>Entity.version()</code></a>, <a href="../../../../com/sleepycat/persist/model/Persistent.html#version()"><code>Persistent.version()</code></a></dd></dl> </li> </ul> <a name="getId()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getId</h4> <pre>int getId()</pre> <div class="block">Returns the internal unique ID for this type.</div> </li> </ul> <a name="isSimple()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isSimple</h4> <pre>boolean isSimple()</pre> <div class="block">Returns whether this is a <a href="../model/Entity.html#simpleTypes">simple type</a>: primitive, primitive wrapper, BigInteger, String or Date. <!-- primitive wrapper, BigInteger, BigDecimal, String or Date. --> <p>If true is returned, <a href="../../../../com/sleepycat/persist/raw/RawType.html#isPrimitive()"><code>isPrimitive()</code></a> can be called for more information, and a raw value of this type is represented as a simple type object (not as a <a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw"><code>RawObject</code></a>).</p> <p>If false is returned, this is a complex type, an array type (see <a href="../../../../com/sleepycat/persist/raw/RawType.html#isArray()"><code>isArray()</code></a>), or an enum type, and a raw value of this type is represented as a <a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw"><code>RawObject</code></a>.</p></div> </li> </ul> <a name="isPrimitive()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isPrimitive</h4> <pre>boolean isPrimitive()</pre> <div class="block">Returns whether this type is a Java primitive: char, byte, short, int, long, float or double. <p>If true is returned, this is also a simple type. In other words, primitive types are a subset of simple types.</p> <p>If true is returned, a raw value of this type is represented as a non-null instance of the primitive type's wrapper class. For example, an <code>int</code> raw value is represented as an <code>Integer</code>.</p></div> </li> </ul> <a name="isEnum()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isEnum</h4> <pre>boolean isEnum()</pre> <div class="block">Returns whether this is an enum type. <p>If true is returned, a value of this type is a <a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw"><code>RawObject</code></a> and the enum constant String is available via <a href="../../../../com/sleepycat/persist/raw/RawObject.html#getEnum()"><code>RawObject.getEnum()</code></a>.</p> <p>If false is returned, then this is a complex type, an array type (see <a href="../../../../com/sleepycat/persist/raw/RawType.html#isArray()"><code>isArray()</code></a>), or a simple type (see <a href="../../../../com/sleepycat/persist/raw/RawType.html#isSimple()"><code>isSimple()</code></a>).</p></div> </li> </ul> <a name="getEnumConstants()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEnumConstants</h4> <pre>java.util.List<java.lang.String> getEnumConstants()</pre> <div class="block">Returns an unmodifiable list of the names of the enum instances, or null if this is not an enum type.</div> </li> </ul> <a name="isArray()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isArray</h4> <pre>boolean isArray()</pre> <div class="block">Returns whether this is an array type. Raw value arrays are represented as <a href="../../../../com/sleepycat/persist/raw/RawObject.html" title="class in com.sleepycat.persist.raw"><code>RawObject</code></a> instances. <p>If true is returned, the array component type is returned by <a href="../../../../com/sleepycat/persist/raw/RawType.html#getComponentType()"><code>getComponentType()</code></a> and the number of array dimensions is returned by <a href="../../../../com/sleepycat/persist/raw/RawType.html#getDimensions()"><code>getDimensions()</code></a>.</p> <p>If false is returned, then this is a complex type, an enum type (see <a href="../../../../com/sleepycat/persist/raw/RawType.html#isEnum()"><code>isEnum()</code></a>), or a simple type (see <a href="../../../../com/sleepycat/persist/raw/RawType.html#isSimple()"><code>isSimple()</code></a>).</p></div> </li> </ul> <a name="getDimensions()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDimensions</h4> <pre>int getDimensions()</pre> <div class="block">Returns the number of array dimensions, or zero if this is not an array type.</div> </li> </ul> <a name="getComponentType()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getComponentType</h4> <pre><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a> getComponentType()</pre> <div class="block">Returns the array component type, or null if this is not an array type.</div> </li> </ul> <a name="getFields()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFields</h4> <pre>java.util.Map<java.lang.String,<a href="../../../../com/sleepycat/persist/raw/RawField.html" title="interface in com.sleepycat.persist.raw">RawField</a>> getFields()</pre> <div class="block">Returns a map of field name to raw field for each non-static non-transient field declared in this class, or null if this is not a complex type (in other words, this is a simple type or an array type).</div> </li> </ul> <a name="getSuperType()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSuperType</h4> <pre><a href="../../../../com/sleepycat/persist/raw/RawType.html" title="interface in com.sleepycat.persist.raw">RawType</a> getSuperType()</pre> <div class="block">Returns the type of the superclass, or null if the superclass is Object or this is not a complex type (in other words, this is a simple type or an array type).</div> </li> </ul> <a name="getClassMetadata()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getClassMetadata</h4> <pre><a href="../../../../com/sleepycat/persist/model/ClassMetadata.html" title="class in com.sleepycat.persist.model">ClassMetadata</a> getClassMetadata()</pre> <div class="block">Returns the original model class metadata used to create this class, or null if this is not a model class.</div> </li> </ul> <a name="getEntityMetadata()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEntityMetadata</h4> <pre><a href="../../../../com/sleepycat/persist/model/EntityMetadata.html" title="class in com.sleepycat.persist.model">EntityMetadata</a> getEntityMetadata()</pre> <div class="block">Returns the original model entity metadata used to create this class, or null if this is not an entity class.</div> </li> </ul> <a name="toString()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> <pre>java.lang.String toString()</pre> <div class="block">Returns an XML representation of the raw type.</div> <dl> <dt><strong>Overrides:</strong></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></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="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="../../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><span class="strong">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/sleepycat/persist/raw/RawType.html" target="_top">Frames</a></li> <li><a href="RawType.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: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>