| <!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>PdxWriter (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="PdxWriter (Apache Geode 1.15.0)"; |
| } |
| } |
| 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,"i26":6,"i27":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/PdxUnreadFields.html" title="interface in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/ReflectionBasedAutoSerializer.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/PdxWriter.html" target="_top">Frames</a></li> |
| <li><a href="PdxWriter.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 PdxWriter" class="title">Interface PdxWriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PdxWriter</span></pre> |
| <div class="block">A PdxWriter will be passed to <a href="../../../../org/apache/geode/pdx/PdxSerializable.html#toData-org.apache.geode.pdx.PdxWriter-"><code>toData</code></a> or |
| <a href="../../../../org/apache/geode/pdx/PdxSerializer.html#toData-java.lang.Object-org.apache.geode.pdx.PdxWriter-"><code>PdxSerializer toData</code></a> by GemFire when it is |
| serializing the domain class. The domain class needs to serialize instance fields using this |
| interface. This interface is implemented by GemFire. |
| <p> |
| The order in which the fields are written must match the order in which they are read by |
| <a href="../../../../org/apache/geode/pdx/PdxReader.html" title="interface in org.apache.geode.pdx"><code>PdxReader</code></a>. |
| <p> |
| Field names are case sensitive. |
| <p> |
| All methods on this interface return itself to allow method calls to be chained together.</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><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#markIdentityField-java.lang.String-">markIdentityField</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">Indicate that the named field should be included in hashCode and equals checks of this object |
| on a server that is accessing <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> or when a client executes a query on a |
| server.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeArrayOfByteArrays-java.lang.String-byte:A:A-">writeArrayOfByteArrays</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, |
| byte[][] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBoolean-java.lang.String-boolean-">writeBoolean</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, |
| boolean value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBooleanArray-java.lang.String-boolean:A-">writeBooleanArray</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, |
| boolean[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByte-java.lang.String-byte-">writeByte</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, |
| byte value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByteArray-java.lang.String-byte:A-">writeByteArray</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, |
| byte[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeChar-java.lang.String-char-">writeChar</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, |
| char value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeCharArray-java.lang.String-char:A-">writeCharArray</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, |
| char[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDate-java.lang.String-java.util.Date-">writeDate</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, |
| <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> value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDouble-java.lang.String-double-">writeDouble</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, |
| double value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDoubleArray-java.lang.String-double:A-">writeDoubleArray</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, |
| double[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><CT,VT extends CT><br><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeField-java.lang.String-VT-java.lang.Class-">writeField</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, |
| VT fieldValue, |
| <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><CT> fieldType)</code> |
| <div class="block">Writes the named field with the given value and type to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><CT,VT extends CT><br><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeField-java.lang.String-VT-java.lang.Class-boolean-">writeField</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, |
| VT fieldValue, |
| <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><CT> fieldType, |
| boolean checkPortability)</code> |
| <div class="block">Writes the named field with the given value and type to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloat-java.lang.String-float-">writeFloat</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, |
| float value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloatArray-java.lang.String-float:A-">writeFloatArray</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, |
| float[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeInt-java.lang.String-int-">writeInt</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, |
| int value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeIntArray-java.lang.String-int:A-">writeIntArray</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, |
| int[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLong-java.lang.String-long-">writeLong</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, |
| long value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLongArray-java.lang.String-long:A-">writeLongArray</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, |
| long[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-">writeObject</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, |
| <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> value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-">writeObject</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, |
| <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> value, |
| boolean checkPortability)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObjectArray-java.lang.String-java.lang.Object:A-">writeObjectArray</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, |
| <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>[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObjectArray-java.lang.String-java.lang.Object:A-boolean-">writeObjectArray</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, |
| <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>[] value, |
| boolean checkPortability)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShort-java.lang.String-short-">writeShort</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, |
| short value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShortArray-java.lang.String-short:A-">writeShortArray</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, |
| short[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeString-java.lang.String-java.lang.String-">writeString</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, |
| <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> value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeStringArray-java.lang.String-java.lang.String:A-">writeStringArray</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, |
| <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>[] value)</code> |
| <div class="block">Writes the named field with the given value to the serialized form.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeUnreadFields-org.apache.geode.pdx.PdxUnreadFields-">writeUnreadFields</a></span>(<a href="../../../../org/apache/geode/pdx/PdxUnreadFields.html" title="interface in org.apache.geode.pdx">PdxUnreadFields</a> unread)</code> |
| <div class="block">Writes the given unread fields to the serialized form.</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="writeChar-java.lang.String-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeChar</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeChar(<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, |
| char value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>char</code>. |
| <p> |
| Java char is mapped to .NET System.Char.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeBoolean-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeBoolean</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeBoolean(<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, |
| boolean value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>boolean</code>. |
| <p> |
| Java boolean is mapped to .NET System.Boolean.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeByte-java.lang.String-byte-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeByte</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeByte(<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, |
| byte value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>byte</code>. |
| <p> |
| Java byte is mapped to .NET System.SByte.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeShort-java.lang.String-short-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeShort</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeShort(<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, |
| short value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>short</code>. |
| <p> |
| Java short is mapped to .NET System.Int16.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeInt-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeInt</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeInt(<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, |
| int value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>int</code>. |
| <p> |
| Java int is mapped to .NET System.Int32.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeLong-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLong</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeLong(<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, |
| long value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>long</code>. |
| <p> |
| Java long is mapped to .NET System.Int64.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeFloat-java.lang.String-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFloat</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeFloat(<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, |
| float value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>float</code>. |
| <p> |
| Java float is mapped to .NET System.Float.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeDouble-java.lang.String-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeDouble</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeDouble(<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, |
| double value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>double</code>. |
| <p> |
| Java double is mapped to .NET System.Double.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeDate-java.lang.String-java.util.Date-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeDate</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeDate(<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, |
| <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> value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>Date</code>. |
| <p> |
| Java Date is mapped to .NET System.DateTime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeString-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeString</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeString(<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, |
| <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> value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>String</code>. |
| <p> |
| Java String is mapped to .NET System.String.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeObject-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeObject</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeObject(<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, |
| <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> value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>Object</code>. |
| <p> |
| It is best to use one of the other writeXXX methods if your field type will always be XXX. This |
| method allows the field value to be anything that is an instance of Object. This gives you more |
| flexibility but more space is used to store the serialized field. |
| <p> |
| Note that some Java objects serialized with this method may not be compatible with non-java |
| languages. To ensure that only portable objects are serialized use |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-"><code>writeObject(String, Object, boolean)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeObject-java.lang.String-java.lang.Object-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeObject</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeObject(<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, |
| <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> value, |
| boolean checkPortability)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>Object</code>. |
| <p> |
| It is best to use one of the other writeXXX methods if your field type will always be XXX. This |
| method allows the field value to be anything that is an instance of Object. This gives you more |
| flexibility but more space is used to store the serialized field. |
| <p> |
| Note that some Java objects serialized with this method may not be compatible with non-java |
| languages. To ensure that only portable objects are serialized set the |
| <code>checkPortability</code> parameter to true. The following is a list of the Java classes |
| that are portable and the .NET class they are mapped to: |
| <ul> |
| <li>instances of <a href="../../../../org/apache/geode/pdx/PdxSerializable.html" title="interface in org.apache.geode.pdx"><code>PdxSerializable</code></a>: .NET class of same name |
| <li>instances of <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a>: .NET class of same name |
| <li>instances serialized by a <a href="../../../../org/apache/geode/pdx/PdxSerializer.html" title="interface in org.apache.geode.pdx"><code>PdxSerializer</code></a>: .NET class of same name |
| <li>java.lang.Byte: System.SByte |
| <li>java.lang.Boolean: System.Boolean |
| <li>java.lang.Character: System.Char |
| <li>java.lang.Short: System.Int16 |
| <li>java.lang.Integer: System.Int32 |
| <li>java.lang.Long: System.Int64 |
| <li>java.lang.Float: System.Float |
| <li>java.lang.Double: System.Double |
| <li>java.lang.String: System.String |
| <li>java.util.Date: System.DateTime |
| <li>byte[]: System.Byte[] |
| <li>boolean[]: System.Boolean[] |
| <li>char[]: System.Char[] |
| <li>short[]: System.Int16[] |
| <li>int[]: System.Int32[] |
| <li>long[]: System.Int64[] |
| <li>float[]: System.Float[] |
| <li>double[]: System.Double[] |
| <li>String[]: System.String[] |
| <li>byte[][]: System.Byte[][] |
| <li>Object[]: System.Collections.Generic.List<Object> |
| <li>java.util.HashMap: System.Collections.Generics.IDictionary<Object, Object> |
| <li>java.util.Hashtable: System.Collections.Hashtable |
| <li>java.util.ArrayList: System.Collections.Generic.IList<Object> |
| <li>java.util.Vector: System.Collections.ArrayList |
| <li>java.util.HashSet: CacheableHashSet |
| <li>java.util.LinkedHashSet: CacheableLinkedHashSet |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dd><code>checkPortability</code> - if true then an exception is thrown if a non-portable object is |
| serialized</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/NonPortableClassException.html" title="class in org.apache.geode.pdx">NonPortableClassException</a></code> - if checkPortability is true and a non-portable object is |
| serialized</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.6.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeBooleanArray-java.lang.String-boolean:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeBooleanArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeBooleanArray(<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, |
| boolean[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>boolean[]</code>. |
| <p> |
| Java boolean[] is mapped to .NET System.Boolean[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeCharArray-java.lang.String-char:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeCharArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeCharArray(<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, |
| char[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>char[]</code>. |
| <p> |
| Java char[] is mapped to .NET System.Char[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeByteArray-java.lang.String-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeByteArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeByteArray(<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, |
| byte[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>byte[]</code>. |
| <p> |
| Java byte[] is mapped to .NET System.Byte[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeShortArray-java.lang.String-short:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeShortArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeShortArray(<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, |
| short[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>short[]</code>. |
| <p> |
| Java short[] is mapped to .NET System.Int16[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeIntArray-java.lang.String-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeIntArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeIntArray(<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, |
| int[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>int[]</code>. |
| <p> |
| Java int[] is mapped to .NET System.Int32[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeLongArray-java.lang.String-long:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeLongArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeLongArray(<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, |
| long[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>long[]</code>. |
| <p> |
| Java long[] is mapped to .NET System.Int64[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeFloatArray-java.lang.String-float:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeFloatArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeFloatArray(<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, |
| float[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>float[]</code>. |
| <p> |
| Java float[] is mapped to .NET System.Float[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeDoubleArray-java.lang.String-double:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeDoubleArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeDoubleArray(<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, |
| double[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>double[]</code>. |
| <p> |
| Java double[] is mapped to .NET System.Double[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeStringArray-java.lang.String-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeStringArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeStringArray(<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, |
| <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>[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>String[]</code>. |
| <p> |
| Java String[] is mapped to .NET System.String[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeObjectArray-java.lang.String-java.lang.Object:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeObjectArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeObjectArray(<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, |
| <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>[] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>Object[]</code>. |
| <p> |
| Java Object[] is mapped to .NET <code>System.Collections.Generic.List<Object></code>. For how each |
| element |
| of the array is a mapped to .NET see <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-"><code>writeObject</code></a>. |
| Note that this call may serialize elements that are not compatible with non-java languages. To |
| ensure that only portable objects are serialized use |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObjectArray-java.lang.String-java.lang.Object:A-boolean-"><code>writeObjectArray(String, Object[], boolean)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeObjectArray-java.lang.String-java.lang.Object:A-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeObjectArray</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeObjectArray(<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, |
| <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>[] value, |
| boolean checkPortability)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>Object[]</code>. |
| <p> |
| Java Object[] is mapped to .NET System.Collections.Generic.List<Object>. For how each |
| element |
| of the array is a mapped to .NET see <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-"><code>writeObject</code></a>. |
| Note that this call may serialize elements that are not compatible with non-java languages. To |
| ensure that only portable objects are serialized use this method</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dd><code>checkPortability</code> - if true then an exception is thrown if a non-portable object is |
| serialized</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/NonPortableClassException.html" title="class in org.apache.geode.pdx">NonPortableClassException</a></code> - if checkPortability is true and a non-portable element is |
| serialized</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.6.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeArrayOfByteArrays-java.lang.String-byte:A:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeArrayOfByteArrays</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeArrayOfByteArrays(<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, |
| byte[][] value)</pre> |
| <div class="block">Writes the named field with the given value to the serialized form. The fields type is |
| <code>byte[][]</code>. |
| <p> |
| Java byte[][] is mapped to .NET System.Byte[][].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>value</code> - the value of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeField-java.lang.String-java.lang.Object-java.lang.Class-"> |
| <!-- --> |
| </a><a name="writeField-java.lang.String-VT-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeField</h4> |
| <pre><CT,VT extends CT> <a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeField(<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, |
| VT fieldValue, |
| <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><CT> fieldType)</pre> |
| <div class="block">Writes the named field with the given value and type to the serialized form. This method uses |
| the <code>fieldType</code> to determine which writeXXX method it should call. If it can not |
| find a specific match to a writeXXX method it will call <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-"><code>writeObject</code></a>. This method may serialize objects that are not portable to non-java languages. To |
| ensure that only objects that are portable to non-java languages are serialized use |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeField-java.lang.String-VT-java.lang.Class-boolean-"><code>writeField(String, Object, Class, boolean)</code></a> instead. |
| <p> |
| The fieldTypes that map to a specific method are: |
| <ul> |
| <li>boolean.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBoolean-java.lang.String-boolean-"><code>writeBoolean(java.lang.String, boolean)</code></a> |
| <li>byte.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByte-java.lang.String-byte-"><code>writeByte(java.lang.String, byte)</code></a> |
| <li>char.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeChar-java.lang.String-char-"><code>writeChar(java.lang.String, char)</code></a> |
| <li>short.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShort-java.lang.String-short-"><code>writeShort(java.lang.String, short)</code></a> |
| <li>int.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeInt-java.lang.String-int-"><code>writeInt(java.lang.String, int)</code></a> |
| <li>long.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLong-java.lang.String-long-"><code>writeLong(java.lang.String, long)</code></a> |
| <li>float.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloat-java.lang.String-float-"><code>writeFloat(java.lang.String, float)</code></a> |
| <li>double.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDouble-java.lang.String-double-"><code>writeDouble(java.lang.String, double)</code></a> |
| <li>String.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeString-java.lang.String-java.lang.String-"><code>writeString(java.lang.String, java.lang.String)</code></a> |
| <li>Date.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDate-java.lang.String-java.util.Date-"><code>writeDate(java.lang.String, java.util.Date)</code></a> |
| <li>boolean[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBooleanArray-java.lang.String-boolean:A-"><code>writeBooleanArray(java.lang.String, boolean[])</code></a> |
| <li>byte[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByteArray-java.lang.String-byte:A-"><code>writeByteArray(java.lang.String, byte[])</code></a> |
| <li>char[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeCharArray-java.lang.String-char:A-"><code>writeCharArray(java.lang.String, char[])</code></a> |
| <li>short[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShortArray-java.lang.String-short:A-"><code>writeShortArray(java.lang.String, short[])</code></a> |
| <li>int[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeIntArray-java.lang.String-int:A-"><code>writeIntArray(java.lang.String, int[])</code></a> |
| <li>long[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLongArray-java.lang.String-long:A-"><code>writeLongArray(java.lang.String, long[])</code></a> |
| <li>float[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloatArray-java.lang.String-float:A-"><code>writeFloatArray(java.lang.String, float[])</code></a> |
| <li>double[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDoubleArray-java.lang.String-double:A-"><code>writeDoubleArray(java.lang.String, double[])</code></a> |
| <li>String[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeStringArray-java.lang.String-java.lang.String:A-"><code>writeStringArray(java.lang.String, java.lang.String[])</code></a> |
| <li>byte[][].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeArrayOfByteArrays-java.lang.String-byte:A:A-"><code>writeArrayOfByteArrays(java.lang.String, byte[][])</code></a> |
| <li>any other array class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObjectArray-java.lang.String-java.lang.Object:A-"><code>writeObjectArray(java.lang.String, java.lang.Object[])</code></a> |
| </ul> |
| Note that the object form of primitives, for example Integer.class and Long.class, map to |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-"><code>writeObject</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>CT</code> - the type associated with the class of the field to write</dd> |
| <dd><code>VT</code> - the type associated with the value of the field to write</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>fieldValue</code> - the value of the field to write; this parameter's class must extend the |
| <code>fieldType</code></dd> |
| <dd><code>fieldType</code> - the type of the field to write</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeField-java.lang.String-java.lang.Object-java.lang.Class-boolean-"> |
| <!-- --> |
| </a><a name="writeField-java.lang.String-VT-java.lang.Class-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeField</h4> |
| <pre><CT,VT extends CT> <a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeField(<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, |
| VT fieldValue, |
| <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><CT> fieldType, |
| boolean checkPortability)</pre> |
| <div class="block">Writes the named field with the given value and type to the serialized form. This method uses |
| the <code>fieldType</code> to determine which writeXXX method it should call. If it can not |
| find a specific match to a writeXXX method it will call |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-"><code>writeObject</code></a>. To ensure that only objects that are |
| portable to non-java languages are serialized set the <code>checkPortability</code> parameter |
| to true. |
| <p> |
| The fieldTypes that map to a specific method are: |
| <ul> |
| <li>boolean.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBoolean-java.lang.String-boolean-"><code>writeBoolean(java.lang.String, boolean)</code></a> |
| <li>byte.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByte-java.lang.String-byte-"><code>writeByte(java.lang.String, byte)</code></a> |
| <li>char.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeChar-java.lang.String-char-"><code>writeChar(java.lang.String, char)</code></a> |
| <li>short.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShort-java.lang.String-short-"><code>writeShort(java.lang.String, short)</code></a> |
| <li>int.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeInt-java.lang.String-int-"><code>writeInt(java.lang.String, int)</code></a> |
| <li>long.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLong-java.lang.String-long-"><code>writeLong(java.lang.String, long)</code></a> |
| <li>float.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloat-java.lang.String-float-"><code>writeFloat(java.lang.String, float)</code></a> |
| <li>double.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDouble-java.lang.String-double-"><code>writeDouble(java.lang.String, double)</code></a> |
| <li>String.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeString-java.lang.String-java.lang.String-"><code>writeString(java.lang.String, java.lang.String)</code></a> |
| <li>Date.class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDate-java.lang.String-java.util.Date-"><code>writeDate(java.lang.String, java.util.Date)</code></a> |
| <li>boolean[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeBooleanArray-java.lang.String-boolean:A-"><code>writeBooleanArray(java.lang.String, boolean[])</code></a> |
| <li>byte[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeByteArray-java.lang.String-byte:A-"><code>writeByteArray(java.lang.String, byte[])</code></a> |
| <li>char[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeCharArray-java.lang.String-char:A-"><code>writeCharArray(java.lang.String, char[])</code></a> |
| <li>short[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeShortArray-java.lang.String-short:A-"><code>writeShortArray(java.lang.String, short[])</code></a> |
| <li>int[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeIntArray-java.lang.String-int:A-"><code>writeIntArray(java.lang.String, int[])</code></a> |
| <li>long[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeLongArray-java.lang.String-long:A-"><code>writeLongArray(java.lang.String, long[])</code></a> |
| <li>float[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeFloatArray-java.lang.String-float:A-"><code>writeFloatArray(java.lang.String, float[])</code></a> |
| <li>double[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeDoubleArray-java.lang.String-double:A-"><code>writeDoubleArray(java.lang.String, double[])</code></a> |
| <li>String[].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeStringArray-java.lang.String-java.lang.String:A-"><code>writeStringArray(java.lang.String, java.lang.String[])</code></a> |
| <li>byte[][].class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeArrayOfByteArrays-java.lang.String-byte:A:A-"><code>writeArrayOfByteArrays(java.lang.String, byte[][])</code></a> |
| <li>any other array class: <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObjectArray-java.lang.String-java.lang.Object:A-boolean-"><code>writeObjectArray(String, Object[], boolean)</code></a> |
| </ul> |
| Note that the object form of primitives, for example Integer.class and Long.class, map to |
| <a href="../../../../org/apache/geode/pdx/PdxWriter.html#writeObject-java.lang.String-java.lang.Object-boolean-"><code>writeObject</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>CT</code> - the type associated with the class of the field to write</dd> |
| <dd><code>VT</code> - the type associated with the value of the field to write</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to write</dd> |
| <dd><code>fieldValue</code> - the value of the field to write; this parameter's class must extend the |
| <code>fieldType</code></dd> |
| <dd><code>fieldType</code> - the type of the field to write</dd> |
| <dd><code>checkPortability</code> - if true then an exception is thrown if a non-portable object is |
| serialized</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if the named field has already been written</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/NonPortableClassException.html" title="class in org.apache.geode.pdx">NonPortableClassException</a></code> - if checkPortability is true and a non-portable object is |
| serialized</dd> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxSerializationException.html" title="class in org.apache.geode.pdx">PdxSerializationException</a></code> - if serialization of the field fails.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.6.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeUnreadFields-org.apache.geode.pdx.PdxUnreadFields-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeUnreadFields</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> writeUnreadFields(<a href="../../../../org/apache/geode/pdx/PdxUnreadFields.html" title="interface in org.apache.geode.pdx">PdxUnreadFields</a> unread)</pre> |
| <div class="block">Writes the given unread fields to the serialized form. The unread fields are obtained by |
| calling <a href="../../../../org/apache/geode/pdx/PdxReader.html#readUnreadFields--"><code>readUnreadFields</code></a>. |
| <p> |
| This method must be called first before any of the writeXXX methods is called.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>unread</code> - the object that was returned from <a href="../../../../org/apache/geode/pdx/PdxReader.html#readUnreadFields--"><code>readUnreadFields</code></a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldAlreadyExistsException.html" title="class in org.apache.geode.pdx">PdxFieldAlreadyExistsException</a></code> - if one of the writeXXX methods has already been called.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="markIdentityField-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>markIdentityField</h4> |
| <pre><a href="../../../../org/apache/geode/pdx/PdxWriter.html" title="interface in org.apache.geode.pdx">PdxWriter</a> markIdentityField(<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">Indicate that the named field should be included in hashCode and equals checks of this object |
| on a server that is accessing <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> or when a client executes a query on a |
| server. |
| |
| The fields that are marked as identity fields are used to generate the hashCode and equals |
| methods of <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a>. Because of this, the identity fields should themselves either |
| be primitives, or implement hashCode and equals. |
| |
| If no fields are set as identity fields, then all fields will be used in hashCode and equals |
| checks. |
| |
| The identity fields should be marked after they are written using a write* method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fieldName</code> - the name of the field to mark as an identity field.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this PdxWriter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/PdxFieldDoesNotExistException.html" title="class in org.apache.geode.pdx">PdxFieldDoesNotExistException</a></code> - if the named field has not already been written.</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/PdxUnreadFields.html" title="interface in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/ReflectionBasedAutoSerializer.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/PdxWriter.html" target="_top">Frames</a></li> |
| <li><a href="PdxWriter.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> |
