PlotSquared/doc/com/intellectualcrafters/json/JSONML.html
2014-11-16 11:14:40 +01:00

511 lines
28 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="sv">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Nov 16 11:09:55 CET 2014 -->
<title>JSONML</title>
<meta name="date" content="2014-11-16">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title = "JSONML";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualcrafters/json/JSONML.html" target="_top">Frames</a></li>
<li><a href="JSONML.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.intellectualcrafters.json</div>
<h2 title="Class JSONML" class="title">Class JSONML</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.intellectualcrafters.json.JSONML</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">JSONML</span>
extends java.lang.Object</pre>
<div class="block">This provides static methods to convert an XML text into a JSONArray or
JSONObject, and to covert a JSONArray or JSONObject into an XML text using
the JsonML transform.
</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#JSONML()">JSONML</a></strong>()</code>&nbsp;
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a></code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toJSONArray(java.lang.String)">toJSONArray</a></strong>(java.lang.String&nbsp;string)</code>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONArray using the JsonML transform.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a></code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toJSONArray(com.intellectualcrafters.json.XMLTokener)">toJSONArray</a></strong>(<a
href="../../../com/intellectualcrafters/json/XMLTokener.html"
title="class in com.intellectualcrafters.json">XMLTokener</a>&nbsp;x)</code>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONArray using the JsonML transform.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a></code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toJSONObject(java.lang.String)">toJSONObject</a></strong>(java.lang.String&nbsp;string)</code>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONObject using the JsonML transform.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a></code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toJSONObject(com.intellectualcrafters.json.XMLTokener)">toJSONObject</a></strong>(<a
href="../../../com/intellectualcrafters/json/XMLTokener.html"
title="class in com.intellectualcrafters.json">XMLTokener</a>&nbsp;x)</code>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONObject using the JsonML transform.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toString(com.intellectualcrafters.json.JSONArray)">toString</a></strong>(<a
href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a>&nbsp;ja)</code>
<div class="block">Reverse the JSONML transformation, making an XML text from a
JSONArray.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a
href="../../../com/intellectualcrafters/json/JSONML.html#toString(com.intellectualcrafters.json.JSONObject)">toString</a></strong>(<a
href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a>&nbsp;jo)</code>
<div class="block">Reverse the JSONML transformation, making an XML text from a
JSONObject.
</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait,
wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JSONML()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JSONML</h4>
<pre>public&nbsp;JSONML()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toJSONArray(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toJSONArray</h4>
<pre>public static&nbsp;<a href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a>&nbsp;toJSONArray(java.lang.String&nbsp;string)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONArray using the JsonML transform. Each XML tag is represented as
a JSONArray in which the first element is the tag name. If the tag has
attributes, then the second element will be JSONObject containing the
name/value pairs. If the tag contains children, then strings and
JSONArrays will represent the child tags.
Comments, prologs, DTDs, and <code>&lt;[ [ ]]></code> are ignored.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>string</code> - The source string.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>A JSONArray containing the structured data from the XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
<a name="toJSONArray(com.intellectualcrafters.json.XMLTokener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toJSONArray</h4>
<pre>public static&nbsp;<a href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a>&nbsp;toJSONArray(<a
href="../../../com/intellectualcrafters/json/XMLTokener.html" title="class in com.intellectualcrafters.json">XMLTokener</a>&nbsp;x)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONArray using the JsonML transform. Each XML tag is represented as
a JSONArray in which the first element is the tag name. If the tag has
attributes, then the second element will be JSONObject containing the
name/value pairs. If the tag contains children, then strings and
JSONArrays will represent the child content and tags.
Comments, prologs, DTDs, and <code>&lt;[ [ ]]></code> are ignored.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>x</code> - An XMLTokener.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>A JSONArray containing the structured data from the XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
<a name="toJSONObject(com.intellectualcrafters.json.XMLTokener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toJSONObject</h4>
<pre>public static&nbsp;<a href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a>&nbsp;toJSONObject(<a
href="../../../com/intellectualcrafters/json/XMLTokener.html" title="class in com.intellectualcrafters.json">XMLTokener</a>&nbsp;x)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONObject using the JsonML transform. Each XML tag is represented as
a JSONObject with a "tagName" property. If the tag has attributes, then
the attributes will be in the JSONObject as properties. If the tag
contains children, the object will have a "childNodes" property which
will be an array of strings and JsonML JSONObjects.
<p/>
Comments, prologs, DTDs, and <code>&lt;[ [ ]]></code> are ignored.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>x</code> - An XMLTokener of the XML source text.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>A JSONObject containing the structured data from the XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
<a name="toJSONObject(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toJSONObject</h4>
<pre>public static&nbsp;<a href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a>&nbsp;toJSONObject(java.lang.String&nbsp;string)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
JSONObject using the JsonML transform. Each XML tag is represented as
a JSONObject with a "tagName" property. If the tag has attributes, then
the attributes will be in the JSONObject as properties. If the tag
contains children, the object will have a "childNodes" property which
will be an array of strings and JsonML JSONObjects.
<p/>
Comments, prologs, DTDs, and <code>&lt;[ [ ]]></code> are ignored.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>string</code> - The XML source text.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>A JSONObject containing the structured data from the XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
<a name="toString(com.intellectualcrafters.json.JSONArray)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public static&nbsp;java.lang.String&nbsp;toString(<a href="../../../com/intellectualcrafters/json/JSONArray.html"
title="class in com.intellectualcrafters.json">JSONArray</a>&nbsp;ja)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Reverse the JSONML transformation, making an XML text from a JSONArray.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>ja</code> - A JSONArray.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>An XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
<a name="toString(com.intellectualcrafters.json.JSONObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public static&nbsp;java.lang.String&nbsp;toString(<a href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json">JSONObject</a>&nbsp;jo)
throws <a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></pre>
<div class="block">Reverse the JSONML transformation, making an XML text from a JSONObject.
The JSONObject must contain a "tagName" property. If it has children,
then it must have a "childNodes" property containing an array of objects.
The other properties are attributes with string values.
</div>
<dl>
<dt><span class="strong">Parameters:</span></dt>
<dd><code>jo</code> - A JSONObject.</dd>
<dt><span class="strong">Returns:</span></dt>
<dd>An XML string.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json">JSONException</a></code>
</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/intellectualcrafters/json/JSONException.html"
title="class in com.intellectualcrafters.json"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/intellectualcrafters/json/JSONObject.html"
title="class in com.intellectualcrafters.json"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/intellectualcrafters/json/JSONML.html" target="_top">Frames</a></li>
<li><a href="JSONML.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>