| <!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>PdxReader (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="PdxReader (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":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/pdx/PdxInstanceFactory.html" title="interface in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/PdxRegistryMismatchException.html" title="class in org.apache.geode.pdx"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/pdx/PdxReader.html" target="_top">Frames</a></li> |
| <li><a href="PdxReader.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">org.apache.geode.pdx</div> |
| <h2 title="Interface PdxReader" class="title">Interface PdxReader</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PdxReader</span></pre> |
| <div class="block">A PdxReader will be passed to <a href="../../../../org/apache/geode/pdx/PdxSerializable.html#fromData-org.apache.geode.pdx.PdxReader-"><code>fromData</code></a> or |
| <a href="../../../../org/apache/geode/pdx/PdxSerializer.html#fromData-java.lang.Class-org.apache.geode.pdx.PdxReader-"><code>PdxSerializer fromData</code></a> by GemFire during |
| deserialization of a PDX. The domain class needs to deserialize field members using this |
| interface. This interface is implemented by GemFire. Each readXXX call will return the field's |
| value. If the serialized PDX does not contain the named field then a default value will be |
| returned. Standard Java defaults are used. For Objects this is <code>null</code> and for |
| primitives it is <code>0</code> or <code>0.0</code>. |
| <P> |
| You <em>must</em> read fields in the same order they were written by <a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx"><code>PdxWriter</code></a>. |
| <P> |
| The methods on this interface are not thread safe so do not call them concurrently, on the same |
| instance, from more than one thread.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.6</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#hasField-java.lang.String-">hasField</a></span>(<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> fieldName)</code> |
| <div class="block">Checks if the named field exists and returns the result.</div> |
| </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/pdx/PdxReader.html#isIdentityField-java.lang.String-">isIdentityField</a></span>(<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> fieldName)</code> |
| <div class="block">Checks if the named field was <a href="../../../../org/apache/geode/pdx/PdxWriter.html#markIdentityField-java.lang.String-"><code>marked</code></a> as an identity |
| field.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>byte[][]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readArrayOfByteArrays-java.lang.String-">readArrayOfByteArrays</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</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/pdx/PdxReader.html#readBoolean-java.lang.String-">readBoolean</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readBooleanArray-java.lang.String-">readBooleanArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>byte</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readByte-java.lang.String-">readByte</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readByteArray-java.lang.String-">readByteArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>char</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readChar-java.lang.String-">readChar</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>char[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readCharArray-java.lang.String-">readCharArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readDate-java.lang.String-">readDate</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readDouble-java.lang.String-">readDouble</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readDoubleArray-java.lang.String-">readDoubleArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readField-java.lang.String-">readField</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readFloat-java.lang.String-">readFloat</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>float[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readFloatArray-java.lang.String-">readFloatArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readInt-java.lang.String-">readInt</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readIntArray-java.lang.String-">readIntArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readLong-java.lang.String-">readLong</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readLongArray-java.lang.String-">readLongArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readObject-java.lang.String-">readObject</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readObjectArray-java.lang.String-">readObjectArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>short</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readShort-java.lang.String-">readShort</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>short[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readShortArray-java.lang.String-">readShortArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <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/pdx/PdxReader.html#readString-java.lang.String-">readString</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i24" 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/pdx/PdxReader.html#readStringArray-java.lang.String-">readStringArray</a></span>(<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> fieldName)</code> |
| <div class="block">Reads the named field and returns its value.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxUnreadFields.html" title="interface in org.apache.geode.pdx">PdxUnreadFields</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxReader.html#readUnreadFields--">readUnreadFields</a></span>()</code> |
| <div class="block">This method returns an object that represents all the unread fields which must be passed to |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeUnreadFields-org.apache.geode.pdx.PdxUnreadFields-"><code>writeUnreadFields</code></a> in the toData code.</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="readChar-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readChar</h4> |
| <pre>char readChar(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>char</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readBoolean-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readBoolean</h4> |
| <pre>boolean readBoolean(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>boolean</code> field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readByte-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readByte</h4> |
| <pre>byte readByte(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>byte</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readShort-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readShort</h4> |
| <pre>short readShort(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>short</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readInt-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readInt</h4> |
| <pre>int readInt(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>int</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readLong-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readLong</h4> |
| <pre>long readLong(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>long</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readFloat-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFloat</h4> |
| <pre>float readFloat(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>float</code> |
| field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readDouble-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readDouble</h4> |
| <pre>double readDouble(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>double</code> field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readString-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readString</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> readString(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>String</code> field.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readObject-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readObject</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readObject(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not an |
| <code>Object</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readCharArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readCharArray</h4> |
| <pre>char[] readCharArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>char[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readBooleanArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readBooleanArray</h4> |
| <pre>boolean[] readBooleanArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>boolean[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readByteArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readByteArray</h4> |
| <pre>byte[] readByteArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>byte[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readShortArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readShortArray</h4> |
| <pre>short[] readShortArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>short[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readIntArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readIntArray</h4> |
| <pre>int[] readIntArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>int[]</code> |
| field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readLongArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readLongArray</h4> |
| <pre>long[] readLongArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>long[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readFloatArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readFloatArray</h4> |
| <pre>float[] readFloatArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>float[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readDoubleArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readDoubleArray</h4> |
| <pre>double[] readDoubleArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>double[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readStringArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readStringArray</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>[] readStringArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>String[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readObjectArray-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readObjectArray</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] readObjectArray(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>Object[]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readArrayOfByteArrays-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readArrayOfByteArrays</h4> |
| <pre>byte[][] readArrayOfByteArrays(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a |
| <code>byte[][]</code> field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readDate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readDate</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> readDate(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldTypeMismatchException.html" title="class in org.apache.geode.pdx">PdxFieldTypeMismatchException</a></code> - if the named field exists and is not a <code>Date</code> |
| field.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasField</h4> |
| <pre>boolean hasField(<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> fieldName)</pre> |
| <div class="block">Checks if the named field exists and returns the result. |
| <p> |
| This can be useful when writing code that handles more than one version of a PDX class.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the named field exists; otherwise <code>false</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isIdentityField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isIdentityField</h4> |
| <pre>boolean isIdentityField(<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> fieldName)</pre> |
| <div class="block">Checks if the named field was <a href="../../../../org/apache/geode/pdx/PdxWriter.html#markIdentityField-java.lang.String-"><code>marked</code></a> as an identity |
| field. |
| <p> |
| Note that if no fields have been marked then all the fields are used as identity fields even |
| though this method will return <code>false</code> since none of them have been <em>marked</em>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to check</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the named field exists and was marked as an identify field; |
| otherwise <code>false</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readField</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> readField(<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> fieldName)</pre> |
| <div class="block">Reads the named field and returns its value.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to read</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the field if the field exists; otherwise a default value</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if deserialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readUnreadFields--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>readUnreadFields</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxUnreadFields.html" title="interface in org.apache.geode.pdx">PdxUnreadFields</a> readUnreadFields()</pre> |
| <div class="block">This method returns an object that represents all the unread fields which must be passed to |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeUnreadFields-org.apache.geode.pdx.PdxUnreadFields-"><code>writeUnreadFields</code></a> in the toData code. |
| <P> |
| Note that if <a href="../../../../org/apache/geode/cache/CacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>setPdxIgnoreUnreadFields</code></a> or |
| <a href="../../../../org/apache/geode/cache/client/ClientCacheFactory.html#setPdxIgnoreUnreadFields-boolean-"><code>client setPdxIgnoreUnreadFields</code></a> are set to <code>true</code> then this method will always |
| return an object that has no unread fields.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an object that represents the unread fields.</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/pdx/PdxInstanceFactory.html" title="interface in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/PdxRegistryMismatchException.html" title="class in org.apache.geode.pdx"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/pdx/PdxReader.html" target="_top">Frames</a></li> |
| <li><a href="PdxReader.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> |
