| <!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 (1.8.0_272) on Thu Nov 12 16:27:22 PST 2020 --> |
| <title>JSONFormatter (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="JSONFormatter (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":9,"i7":9,"i8":10,"i9":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/FieldType.html" title="enum in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/JSONFormatterException.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/JSONFormatter.html" target="_top">Frames</a></li> |
| <li><a href="JSONFormatter.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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="Class JSONFormatter" class="title">Class JSONFormatter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.geode.pdx.JSONFormatter</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">JSONFormatter</span> |
| extends <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></pre> |
| <div class="block"><p> |
| JSONFormatter has a static method <a href="../../../../org/apache/geode/pdx/JSONFormatter.html#fromJSON-java.lang.String-java.lang.String...-"><code>fromJSON(String, String...)</code></a> to convert a |
| JSON document into a <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> and a static method |
| <a href="../../../../org/apache/geode/pdx/JSONFormatter.html#toJSON-org.apache.geode.pdx.PdxInstance-"><code>toJSON(PdxInstance)</code></a> to convert a <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a> into a JSON Document. |
| </p> |
| <p> |
| Using these methods an applications may convert a JSON document into a PdxInstance for storing in |
| the cache. Indexes can then be defined on the PdxInstances so that queries can be performed using |
| OQL. Queries will return PdxInstances and these can be turned back back into JSON documents using |
| JSONFormatter. |
| </p> |
| <p> |
| JSONFormatter treats values in a json document as number(byte, short, int, long..), string, |
| array, object, 'true', 'false' or 'null'. These correspond to the following java types: |
| </p> |
| |
| <table> |
| <th>JSON</th> |
| <th>Java</th> |
| <tr> |
| <td>object</td> |
| <td><a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx"><code>PdxInstance</code></a></td> |
| </tr> |
| <tr> |
| <td>arrays</td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util"><code>LinkedList</code></a></td> |
| </tr> |
| <tr> |
| <td>BigDecimal</td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a></td> |
| </tr> |
| <tr> |
| <td>BigInterger</td> |
| <td><a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math"><code>BigInteger</code></a></td> |
| </tr> |
| <tr> |
| <td>Double</td> |
| <td>double</td> |
| </tr> |
| <tr> |
| <td>float</td> |
| <td>float</td> |
| </tr> |
| <tr> |
| <td>boolean</td> |
| <td>boolean</td> |
| </tr> |
| <tr> |
| <td>Integer</td> |
| <td>byte, short or int</td> |
| </tr> |
| <tr> |
| <td>null</td> |
| <td>null</td> |
| </tr> |
| </table></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <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/JSONFormatter.html#JSON_CLASSNAME">JSON_CLASSNAME</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <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/JSONFormatter.html#SORT_JSON_FIELD_NAMES_PROPERTY">SORT_JSON_FIELD_NAMES_PROPERTY</a></span></code> |
| <div class="block">By setting "gemfire.sort-json-field-names" to true, enables serialization of JSON field in JSON |
| document to be sorted.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#JSONFormatter--">JSONFormatter</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#JSONFormatter-org.apache.geode.cache.RegionService-">JSONFormatter</a></span>(<a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a> regionService)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#fromJSON-byte:A-">fromJSON</a></span>(byte[] jsonByteArray)</code> |
| <div class="block">Converts a Byte Array JSON document into a PdxInstance</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#fromJSON-byte:A-java.lang.String...-">fromJSON</a></span>(byte[] jsonByteArray, |
| <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>... identityFields)</code> |
| <div class="block">Converts a Byte Array JSON document into a PdxInstance</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#fromJSON-java.lang.String-">fromJSON</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> jsonString)</code> |
| <div class="block">Converts a String JSON document into a PdxInstance</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#fromJSON-java.lang.String-java.lang.String...-">fromJSON</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> jsonString, |
| <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>... identityFields)</code> |
| <div class="block">Converts a String JSON document into a PdxInstance</div> |
| </td> |
| </tr> |
| <tr id="i4" 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/JSONFormatter.html#fromPdxInstance-org.apache.geode.pdx.PdxInstance-">fromPdxInstance</a></span>(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</code> |
| <div class="block">Converts a PdxInstance into a JSON document</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#getRegionService--">getRegionService</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <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/JSONFormatter.html#toJSON-org.apache.geode.pdx.PdxInstance-">toJSON</a></span>(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</code> |
| <div class="block">Converts a PdxInstance into a JSON document in String form</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#toJSONByteArray-org.apache.geode.pdx.PdxInstance-">toJSONByteArray</a></span>(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</code> |
| <div class="block">Converts a PdxInstance into a JSON document in byte-array form</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#toJsonByteArrayFromPdxInstance-org.apache.geode.pdx.PdxInstance-">toJsonByteArrayFromPdxInstance</a></span>(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</code> |
| <div class="block">Converts a PdxInstance into a JSON document in byte-array form</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/pdx/JSONFormatter.html#toPdxInstance-java.lang.Object-java.lang.String...-">toPdxInstance</a></span>(<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> json, |
| <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>... identityFields)</code> |
| <div class="block">Converts a JSON document (String or Byte Array) into a PdxInstance</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="JSON_CLASSNAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JSON_CLASSNAME</h4> |
| <pre>public static final <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> JSON_CLASSNAME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.pdx.JSONFormatter.JSON_CLASSNAME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SORT_JSON_FIELD_NAMES_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SORT_JSON_FIELD_NAMES_PROPERTY</h4> |
| <pre>public static final <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> SORT_JSON_FIELD_NAMES_PROPERTY</pre> |
| <div class="block">By setting "gemfire.sort-json-field-names" to true, enables serialization of JSON field in JSON |
| document to be sorted. That can help to reduce the number of pdx typeId generation if different |
| JSON documents have same fields in the different order.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.geode.pdx.JSONFormatter.SORT_JSON_FIELD_NAMES_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JSONFormatter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JSONFormatter</h4> |
| <pre>public JSONFormatter()</pre> |
| </li> |
| </ul> |
| <a name="JSONFormatter-org.apache.geode.cache.RegionService-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JSONFormatter</h4> |
| <pre>public JSONFormatter(<a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a> regionService)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRegionService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegionService</h4> |
| <pre>public <a href="../../../../org/apache/geode/cache/RegionService.html" title="interface in org.apache.geode.cache">RegionService</a> getRegionService()</pre> |
| </li> |
| </ul> |
| <a name="fromJSON-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromJSON</h4> |
| <pre>public static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> fromJSON(<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> jsonString)</pre> |
| <div class="block">Converts a String JSON document into a PdxInstance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jsonString</code> - The JSON String to convert to PDX</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The PdxInstance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the PdxInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromJSON-java.lang.String-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromJSON</h4> |
| <pre>public static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> fromJSON(<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> jsonString, |
| <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>... identityFields)</pre> |
| <div class="block">Converts a String JSON document into a PdxInstance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jsonString</code> - The JSON String to convert to PDX</dd> |
| <dd><code>identityFields</code> - Any desired identity fields on the JSON object to be used for equals and |
| hashCode computations</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The PdxInstance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the PdxInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromJSON-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromJSON</h4> |
| <pre>public static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> fromJSON(byte[] jsonByteArray)</pre> |
| <div class="block">Converts a Byte Array JSON document into a PdxInstance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jsonByteArray</code> - The JSON Object as a byte array to convert to PDX</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The PdxInstance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the PdxInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromJSON-byte:A-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromJSON</h4> |
| <pre>public static <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> fromJSON(byte[] jsonByteArray, |
| <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>... identityFields)</pre> |
| <div class="block">Converts a Byte Array JSON document into a PdxInstance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jsonByteArray</code> - The JSON Object as a byte array to convert to PDX</dd> |
| <dd><code>identityFields</code> - Any desired identity fields on the JSON object to be used for equals and |
| hashCode computations</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The PdxInstance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the PdxInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toPdxInstance-java.lang.Object-java.lang.String...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toPdxInstance</h4> |
| <pre>public <a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> toPdxInstance(<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> json, |
| <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>... identityFields)</pre> |
| <div class="block">Converts a JSON document (String or Byte Array) into a PdxInstance</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>json</code> - The JSON document (String or Byte Array) to convert to PDX</dd> |
| <dd><code>identityFields</code> - Any desired identity fields on the JSON object to be used for equals and |
| hashCode computations</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The PdxInstance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the PdxInstance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJSON-org.apache.geode.pdx.PdxInstance-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJSON</h4> |
| <pre>public static <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> toJSON(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</pre> |
| <div class="block">Converts a PdxInstance into a JSON document in String form</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxInstance</code> - the JSON string.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JSON string |
| JSONFormatterException if unable to create the JSON document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromPdxInstance-org.apache.geode.pdx.PdxInstance-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromPdxInstance</h4> |
| <pre>public <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> fromPdxInstance(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</pre> |
| <div class="block">Converts a PdxInstance into a JSON document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxInstance</code> - The PdxInstance to convert</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JSON string</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the JSON document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJSONByteArray-org.apache.geode.pdx.PdxInstance-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJSONByteArray</h4> |
| <pre>public static byte[] toJSONByteArray(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</pre> |
| <div class="block">Converts a PdxInstance into a JSON document in byte-array form</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxInstance</code> - The PdxInstance to convert</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JSON byte array</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the JSON document</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJsonByteArrayFromPdxInstance-org.apache.geode.pdx.PdxInstance-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toJsonByteArrayFromPdxInstance</h4> |
| <pre>public byte[] toJsonByteArrayFromPdxInstance(<a href="../../../../org/apache/geode/pdx/PdxInstance.html" title="interface in org.apache.geode.pdx">PdxInstance</a> pdxInstance)</pre> |
| <div class="block">Converts a PdxInstance into a JSON document in byte-array form</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pdxInstance</code> - The PdxInstance to convert</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the JSON byte array</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/pdx/JSONFormatterException.html" title="class in org.apache.geode.pdx">JSONFormatterException</a></code> - if unable to create the JSON document</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/FieldType.html" title="enum in org.apache.geode.pdx"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/pdx/JSONFormatterException.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/JSONFormatter.html" target="_top">Frames</a></li> |
| <li><a href="JSONFormatter.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |