mirror of
https://github.com/stleary/JSON-java.git
synced 2026-05-20 00:00:59 -04:00
update javadoc after recent merges
This commit is contained in:
Sean Leary
@@ -0,0 +1,628 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>CDL</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: CDL">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class CDL" class="title">Class CDL</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.CDL</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CDL</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">This provides static methods to convert comma (or otherwise) delimited text into a
|
||||
JSONArray, and to convert a JSONArray into comma (or otherwise) delimited text. Comma
|
||||
delimited text is a very popular format for data interchange. It is
|
||||
understood by most database, spreadsheet, and organizer programs.
|
||||
<p>
|
||||
Each row of text represents a row in a table or a data record. Each row
|
||||
ends with a NEWLINE character. Each row contains one or more values.
|
||||
Values are separated by commas. A value can contain any character except
|
||||
for comma, unless it is wrapped in single quotes or double quotes.
|
||||
<p>
|
||||
The first row usually contains the names of the columns.
|
||||
<p>
|
||||
A comma delimited list can be converted into a JSONArray of JSONObjects.
|
||||
The names for the elements in the JSONObjects can be taken from the names
|
||||
in the first row.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CDL</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new CDL object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToJSONArray(org.json.JSONTokener)" class="member-name-link">rowToJSONArray</a><wbr>(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of strings from a row of comma delimited values.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToJSONArray(org.json.JSONTokener,char)" class="member-name-link">rowToJSONArray</a><wbr>(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of strings from a row of comma delimited values.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToJSONObject(org.json.JSONArray,org.json.JSONTokener)" class="member-name-link">rowToJSONObject</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONObject from a row of comma delimited text, using a
|
||||
parallel JSONArray of strings to provides the names of the elements.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToJSONObject(org.json.JSONArray,org.json.JSONTokener,char)" class="member-name-link">rowToJSONObject</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONObject from a row of comma delimited text, using a
|
||||
parallel JSONArray of strings to provides the names of the elements.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToString(org.json.JSONArray)" class="member-name-link">rowToString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text row from a JSONArray.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rowToString(org.json.JSONArray,char)" class="member-name-link">rowToString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text row from a JSONArray.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(java.lang.String)" class="member-name-link">toJSONArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(java.lang.String,char)" class="member-name-link">toJSONArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONArray,java.lang.String)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONArray,java.lang.String,char)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONArray,org.json.JSONTokener)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONArray,org.json.JSONTokener,char)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONTokener)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.JSONTokener,char)" class="member-name-link">toJSONArray</a><wbr>(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONArray)" class="member-name-link">toString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONArray,char)" class="member-name-link">toString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONArray,org.json.JSONArray)" class="member-name-link">toString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects using
|
||||
a provided list of names.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONArray,org.json.JSONArray,char)" class="member-name-link">toString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects using
|
||||
a provided list of names.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>CDL</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CDL</span>()</div>
|
||||
<div class="block">Constructs a new CDL object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="rowToJSONArray(org.json.JSONTokener)">
|
||||
<h3>rowToJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">rowToJSONArray</span><wbr><span class="parameters">(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of strings from a row of comma delimited values.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of strings.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="rowToJSONArray(org.json.JSONTokener,char)">
|
||||
<h3>rowToJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">rowToJSONArray</span><wbr><span class="parameters">(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of strings from a row of comma delimited values.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of strings.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="rowToJSONObject(org.json.JSONArray,org.json.JSONTokener)">
|
||||
<h3>rowToJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">rowToJSONObject</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONObject from a row of comma delimited text, using a
|
||||
parallel JSONArray of strings to provides the names of the elements.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of names. This is commonly obtained from the
|
||||
first row of a comma delimited text file using the rowToJSONArray
|
||||
method.</dd>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject combining the names and values.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="rowToJSONObject(org.json.JSONArray,org.json.JSONTokener,char)">
|
||||
<h3>rowToJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">rowToJSONObject</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONObject from a row of comma delimited text, using a
|
||||
parallel JSONArray of strings to provides the names of the elements.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of names. This is commonly obtained from the
|
||||
first row of a comma delimited text file using the rowToJSONArray
|
||||
method.</dd>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject combining the names and values.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="rowToString(org.json.JSONArray)">
|
||||
<h3>rowToString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rowToString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</span></div>
|
||||
<div class="block">Produce a comma delimited text row from a JSONArray. Values containing
|
||||
the comma character will be quoted. Troublesome characters may be
|
||||
removed.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ja</code> - A JSONArray of strings.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string ending in NEWLINE.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="rowToString(org.json.JSONArray,char)">
|
||||
<h3>rowToString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rowToString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</span></div>
|
||||
<div class="block">Produce a comma delimited text row from a JSONArray. Values containing
|
||||
the comma character will be quoted. Troublesome characters may be
|
||||
removed.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ja</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string ending in NEWLINE.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(java.lang.String)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The comma delimited text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(java.lang.String,char)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The comma delimited text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONTokener)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - The JSONTokener containing the comma delimited text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONTokener,char)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string,
|
||||
using the first row as a source of names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - The JSONTokener containing the comma delimited text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONArray,java.lang.String)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>string</code> - The comma delimited text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONArray,java.lang.String,char)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>string</code> - The comma delimited text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONArray,org.json.JSONTokener)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.JSONArray,org.json.JSONTokener,char)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONTokener.html" title="class in org.json">JSONTokener</a> x,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a JSONArray of JSONObjects from a comma delimited text string
|
||||
using a supplied JSONArray as the source of element names.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>x</code> - A JSONTokener of the source text.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray of JSONObjects.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONArray)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects. The
|
||||
first row will be a list of names obtained by inspecting the first
|
||||
JSONObject.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ja</code> - A JSONArray of JSONObjects.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A comma delimited text.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONArray,char)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects. The
|
||||
first row will be a list of names obtained by inspecting the first
|
||||
JSONObject.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ja</code> - A JSONArray of JSONObjects.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A comma delimited text.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONArray,org.json.JSONArray)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects using
|
||||
a provided list of names. The list of names is not included in the
|
||||
output.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>ja</code> - A JSONArray of JSONObjects.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A comma delimited text.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONArray,org.json.JSONArray,char)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> names,
|
||||
<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja,
|
||||
char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Produce a comma delimited text from a JSONArray of JSONObjects using
|
||||
a provided list of names. The list of names is not included in the
|
||||
output.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>names</code> - A JSONArray of strings.</dd>
|
||||
<dd><code>ja</code> - A JSONArray of JSONObjects.</dd>
|
||||
<dd><code>delimiter</code> - custom delimiter char</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A comma delimited text.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,263 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>Cookie</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: Cookie">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class Cookie" class="title">Class Cookie</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.Cookie</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Cookie</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Convert a web browser cookie specification to a JSONObject and back.
|
||||
JSON and Cookies are both notations for name/value pairs.
|
||||
See also: <a href="https://tools.ietf.org/html/rfc6265">https://tools.ietf.org/html/rfc6265</a></div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Cookie</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new Cookie object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#escape(java.lang.String)" class="member-name-link">escape</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Produce a copy of a string in which the characters '+', '%', '=', ';'
|
||||
and control characters are replaced with "%hh".</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a cookie specification string into a JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONObject)" class="member-name-link">toString</a><wbr>(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a cookie specification string.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unescape(java.lang.String)" class="member-name-link">unescape</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert <code>%</code><i>hh</i> sequences to single characters, and
|
||||
convert plus to space.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>Cookie</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Cookie</span>()</div>
|
||||
<div class="block">Constructs a new Cookie object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="escape(java.lang.String)">
|
||||
<h3>escape</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">escape</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Produce a copy of a string in which the characters '+', '%', '=', ';'
|
||||
and control characters are replaced with "%hh". This is a gentle form
|
||||
of URL encoding, attempting to cause as little distortion to the
|
||||
string as possible. The characters '=' and ';' are meta characters in
|
||||
cookies. By convention, they are escaped using the URL-encoding. This is
|
||||
only a convention, not a standard. Often, cookies are expected to have
|
||||
encoded values. We encode '=' and ';' because we must. We encode '%' and
|
||||
'+' because they are meta characters in URL encoding.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The escaped result.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Convert a cookie specification string into a JSONObject. The string
|
||||
must contain a name value pair separated by '='. The name and the value
|
||||
will be unescaped, possibly converting '+' and '%' sequences. The
|
||||
cookie properties may follow, separated by ';', also represented as
|
||||
name=value (except the Attribute properties like "Secure" or "HttpOnly",
|
||||
which do not have a value. The value <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Boolean.html#TRUE" title="class or interface in java.lang" class="external-link"><code>Boolean.TRUE</code></a> will be used for these).
|
||||
The name will be stored under the key "name", and the value will be
|
||||
stored under the key "value". This method does not do checking or
|
||||
validation of the parameters. It only converts the cookie string into
|
||||
a JSONObject. All attribute names are converted to lower case keys in the
|
||||
JSONObject (HttpOnly => httponly). If an attribute is specified more than
|
||||
once, only the value found closer to the end of the cookie-string is kept.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The cookie specification string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing "name", "value", and possibly other
|
||||
members.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If there is an error parsing the Cookie String.
|
||||
Cookie strings must have at least one '=' character and the 'name'
|
||||
portion of the cookie must not be blank.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONObject)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into a cookie specification string. The JSONObject
|
||||
must contain "name" and "value" members (case insensitive).
|
||||
If the JSONObject contains other members, they will be appended to the cookie
|
||||
specification string. User-Agents are instructed to ignore unknown attributes,
|
||||
so ensure your JSONObject is using only known attributes.
|
||||
See also: <a href="https://tools.ietf.org/html/rfc6265">https://tools.ietf.org/html/rfc6265</a></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>jo</code> - A JSONObject</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A cookie specification string</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - thrown if the cookie has no name.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="unescape(java.lang.String)">
|
||||
<h3>unescape</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">unescape</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Convert <code>%</code><i>hh</i> sequences to single characters, and
|
||||
convert plus to space.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - A string that may contain
|
||||
<code>+</code> <small>(plus)</small> and
|
||||
<code>%</code><i>hh</i> sequences.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The unescaped string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,205 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>CookieList</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: CookieList">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class CookieList" class="title">Class CookieList</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.CookieList</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CookieList</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Convert a web browser cookie list string to a JSONObject and back.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CookieList</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new CookieList object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a cookie list into a JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONObject)" class="member-name-link">toString</a><wbr>(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a cookie list.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>CookieList</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CookieList</span>()</div>
|
||||
<div class="block">Constructs a new CookieList object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a cookie list into a JSONObject. A cookie list is a sequence
|
||||
of name/value pairs. The names are separated from the values by '='.
|
||||
The pairs are separated by ';'. The names and the values
|
||||
will be unescaped, possibly converting '+' and '%' sequences.
|
||||
|
||||
To add a cookie to a cookie list,
|
||||
cookielistJSONObject.put(cookieJSONObject.getString("name"),
|
||||
cookieJSONObject.getString("value"));</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - A cookie list string</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONObject)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into a cookie list. A cookie list is a sequence
|
||||
of name/value pairs. The names are separated from the values by '='.
|
||||
The pairs are separated by ';'. The characters '%', '+', '=', and ';'
|
||||
in the names and values are replaced by "%hh".</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>jo</code> - A JSONObject</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A cookie list string</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,275 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>HTTP</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: HTTP">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class HTTP" class="title">Class HTTP</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.HTTP</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">HTTP</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Convert an HTTP header to a JSONObject and back.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#CRLF" class="member-name-link">CRLF</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Carriage return/line feed.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">HTTP</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new HTTP object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert an HTTP header string into a JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONObject)" class="member-name-link">toString</a><wbr>(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into an HTTP header.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="CRLF">
|
||||
<h3>CRLF</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">CRLF</span></div>
|
||||
<div class="block">Carriage return/line feed.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.HTTP.CRLF">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>HTTP</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HTTP</span>()</div>
|
||||
<div class="block">Constructs a new HTTP object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert an HTTP header string into a JSONObject. It can be a request
|
||||
header or a response header. A request header will contain
|
||||
<pre>{
|
||||
Method: "POST" (for example),
|
||||
"Request-URI": "/" (for example),
|
||||
"HTTP-Version": "HTTP/1.1" (for example)
|
||||
}</pre>
|
||||
A response header will contain
|
||||
<pre>{
|
||||
"HTTP-Version": "HTTP/1.1" (for example),
|
||||
"Status-Code": "200" (for example),
|
||||
"Reason-Phrase": "OK" (for example)
|
||||
}</pre>
|
||||
In addition, the other parameters in the header will be captured, using
|
||||
the HTTP field names as JSON names, so that <pre><code>
|
||||
Date: Sun, 26 May 2002 18:06:04 GMT
|
||||
Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
|
||||
Cache-Control: no-cache</code></pre>
|
||||
become
|
||||
<pre><code>
|
||||
Date: "Sun, 26 May 2002 18:06:04 GMT",
|
||||
Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
|
||||
"Cache-Control": "no-cache",
|
||||
...</code></pre>
|
||||
It does no further checking or conversion. It does not parse dates.
|
||||
It does not do '%' transforms on URLs.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - An HTTP header string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the elements and attributes
|
||||
of the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function fails</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONObject)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into an HTTP header. A request header must contain
|
||||
<pre>{
|
||||
Method: "POST" (for example),
|
||||
"Request-URI": "/" (for example),
|
||||
"HTTP-Version": "HTTP/1.1" (for example)
|
||||
}</pre>
|
||||
A response header must contain
|
||||
<pre>{
|
||||
"HTTP-Version": "HTTP/1.1" (for example),
|
||||
"Status-Code": "200" (for example),
|
||||
"Reason-Phrase": "OK" (for example)
|
||||
}</pre>
|
||||
Any other members of the JSONObject will be output as HTTP fields.
|
||||
The result will end with two CRLF pairs.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>jo</code> - A JSONObject</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An HTTP header string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if the object does not contain enough
|
||||
information.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,182 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>HTTPTokener</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: HTTPTokener">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class HTTPTokener" class="title">Class HTTPTokener</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="JSONTokener.html" title="class in org.json">org.json.JSONTokener</a>
|
||||
<div class="inheritance">org.json.HTTPTokener</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">HTTPTokener</span>
|
||||
<span class="extends-implements">extends <a href="JSONTokener.html" title="class in org.json">JSONTokener</a></span></div>
|
||||
<div class="block">The HTTPTokener extends the JSONTokener to provide additional methods
|
||||
for the parsing of HTTP headers.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">HTTPTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct an HTTPTokener from a string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextToken()" class="member-name-link">nextToken</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next token or string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.JSONTokener">Methods inherited from class org.json.<a href="JSONTokener.html" title="class in org.json">JSONTokener</a></h3>
|
||||
<code><a href="JSONTokener.html#back()">back</a>, <a href="JSONTokener.html#close()">close</a>, <a href="JSONTokener.html#dehexchar(char)">dehexchar</a>, <a href="JSONTokener.html#end()">end</a>, <a href="JSONTokener.html#getPrevious()">getPrevious</a>, <a href="JSONTokener.html#more()">more</a>, <a href="JSONTokener.html#next()">next</a>, <a href="JSONTokener.html#next(char)">next</a>, <a href="JSONTokener.html#next(int)">next</a>, <a href="JSONTokener.html#nextClean()">nextClean</a>, <a href="JSONTokener.html#nextString(char)">nextString</a>, <a href="JSONTokener.html#nextTo(char)">nextTo</a>, <a href="JSONTokener.html#nextTo(java.lang.String)">nextTo</a>, <a href="JSONTokener.html#nextValue()">nextValue</a>, <a href="JSONTokener.html#skipTo(char)">skipTo</a>, <a href="JSONTokener.html#syntaxError(java.lang.String)">syntaxError</a>, <a href="JSONTokener.html#syntaxError(java.lang.String,java.lang.Throwable)">syntaxError</a>, <a href="JSONTokener.html#toString()">toString</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>HTTPTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">HTTPTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Construct an HTTPTokener from a string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - A source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="nextToken()">
|
||||
<h3>nextToken</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nextToken</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next token or string. This is used in parsing HTTP headers.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A String.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a syntax error occurs</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,193 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONException</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONException">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li>Method</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONException" class="title">Class JSONException</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
|
||||
<div class="inheritance">org.json.JSONException</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="JSONPointerException.html" title="class in org.json">JSONPointerException</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONException</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">RuntimeException</a></span></div>
|
||||
<div class="block">The JSONException is thrown by the JSON.org classes when things are amiss.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../serialized-form.html#org.json.JSONException">Serialized Form</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">JSONException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a JSONException with an explanatory message.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">JSONException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Constructs a JSONException with an explanatory message and cause.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">JSONException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new JSONException with the specified cause.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>JSONException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div>
|
||||
<div class="block">Constructs a JSONException with an explanatory message.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - Detail about the reason for the exception.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String,java.lang.Throwable)">
|
||||
<h3>JSONException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div>
|
||||
<div class="block">Constructs a JSONException with an explanatory message and cause.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - Detail about the reason for the exception.</dd>
|
||||
<dd><code>cause</code> - The cause.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.Throwable)">
|
||||
<h3>JSONException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div>
|
||||
<div class="block">Constructs a new JSONException with the specified cause.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>cause</code> - The cause.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,594 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONML</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONML">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONML" class="title">Class JSONML</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.JSONML</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONML</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<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>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JSONML</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new JSONML object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(java.lang.String)" class="member-name-link">toJSONArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(java.lang.String,boolean)" class="member-name-link">toJSONArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(java.lang.String,org.json.JSONMLParserConfiguration)" class="member-name-link">toJSONArray</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.XMLTokener)" class="member-name-link">toJSONArray</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.XMLTokener,boolean)" class="member-name-link">toJSONArray</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONArray.html" title="class in org.json">JSONArray</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONArray(org.json.XMLTokener,org.json.JSONMLParserConfiguration)" class="member-name-link">toJSONArray</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONArray using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String,boolean)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String,org.json.JSONMLParserConfiguration)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(org.json.XMLTokener)" class="member-name-link">toJSONObject</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(org.json.XMLTokener,boolean)" class="member-name-link">toJSONObject</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(org.json.XMLTokener,org.json.JSONMLParserConfiguration)" class="member-name-link">toJSONObject</a><wbr>(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject using the JsonML transform.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONArray)" class="member-name-link">toString</a><wbr>(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Reverse the JSONML transformation, making an XML text from a JSONArray.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(org.json.JSONObject)" class="member-name-link">toString</a><wbr>(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Reverse the JSONML transformation, making an XML text from a JSONObject.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>JSONML</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONML</span>()</div>
|
||||
<div class="block">Constructs a new JSONML object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(java.lang.String)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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 <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(java.lang.String,boolean)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
As opposed to toJSONArray this method does not attempt to convert
|
||||
any text node or attribute value to any type
|
||||
but just leaves it as a string.
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(java.lang.String,org.json.JSONMLParserConfiguration)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
As opposed to toJSONArray this method does not attempt to convert
|
||||
any text node or attribute value to any type
|
||||
but just leaves it as a string.
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dd><code>config</code> - The parser configuration:
|
||||
JSONMLParserConfiguration.ORIGINAL is the default behaviour;
|
||||
JSONMLParserConfiguration.KEEP_STRINGS means values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.XMLTokener,org.json.JSONMLParserConfiguration)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
As opposed to toJSONArray this method does not attempt to convert
|
||||
any text node or attribute value to any type
|
||||
but just leaves it as a string.
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener.</dd>
|
||||
<dd><code>config</code> - The parser configuration:
|
||||
JSONMLParserConfiguration.ORIGINAL is the default behaviour;
|
||||
JSONMLParserConfiguration.KEEP_STRINGS means values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.XMLTokener,boolean)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
As opposed to toJSONArray this method does not attempt to convert
|
||||
any text node or attribute value to any type
|
||||
but just leaves it as a string.
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONArray(org.json.XMLTokener)">
|
||||
<h3>toJSONArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONArray.html" title="class in org.json">JSONArray</a></span> <span class="element-name">toJSONArray</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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 <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONArray containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONArray</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The XML source text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String,boolean)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The XML source text.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String,org.json.JSONMLParserConfiguration)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The XML source text.</dd>
|
||||
<dd><code>config</code> - The parser configuration:
|
||||
JSONMLParserConfiguration.ORIGINAL is the default behaviour;
|
||||
JSONMLParserConfiguration.KEEP_STRINGS means values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(org.json.XMLTokener)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener of the XML source text.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(org.json.XMLTokener,boolean)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener of the XML source text.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(org.json.XMLTokener,org.json.JSONMLParserConfiguration)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="XMLTokener.html" title="class in org.json">XMLTokener</a> x,
|
||||
<a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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.
|
||||
|
||||
Comments, prologs, DTDs, and <pre><code>&lt;[ [ ]]></code></pre> are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - An XMLTokener of the XML source text.</dd>
|
||||
<dd><code>config</code> - The parser configuration:
|
||||
JSONMLParserConfiguration.ORIGINAL is the default behaviour;
|
||||
JSONMLParserConfiguration.KEEP_STRINGS means values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a JSONObject</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONArray)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONArray.html" title="class in org.json">JSONArray</a> ja)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Reverse the JSONML transformation, making an XML text from a JSONArray.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ja</code> - A JSONArray.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(org.json.JSONObject)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<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 class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>jo</code> - A JSONObject.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown on error converting to a string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,312 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONMLParserConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONMLParserConfiguration">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONMLParserConfiguration" class="title">Class JSONMLParserConfiguration</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="ParserConfiguration.html" title="class in org.json">org.json.ParserConfiguration</a>
|
||||
<div class="inheritance">org.json.JSONMLParserConfiguration</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONMLParserConfiguration</span>
|
||||
<span class="extends-implements">extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></span></div>
|
||||
<div class="block">Configuration object for the XML to JSONML parser. The configuration is immutable.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#DEFAULT_MAXIMUM_NESTING_DEPTH" class="member-name-link">DEFAULT_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">We can override the default maximum nesting depth if needed.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#KEEP_STRINGS" class="member-name-link">KEEP_STRINGS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Original configuration of the XML to JSONML Parser except that values are kept as strings.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#ORIGINAL" class="member-name-link">ORIGINAL</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Original Configuration of the XML to JSONML Parser.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-org.json.ParserConfiguration">Fields inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#keepStrings">keepStrings</a>, <a href="ParserConfiguration.html#maxNestingDepth">maxNestingDepth</a>, <a href="ParserConfiguration.html#UNDEFINED_MAXIMUM_NESTING_DEPTH">UNDEFINED_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier</div>
|
||||
<div class="table-header col-second">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code> </code></div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JSONMLParserConfiguration</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Default parser configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>protected </code></div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean,int)" class="member-name-link">JSONMLParserConfiguration</a><wbr>(boolean keepStrings,
|
||||
int maxNestingDepth)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Configure the parser string processing and use the default CDATA Tag Name as "content".</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withKeepStrings(boolean)" class="member-name-link">withKeepStrings</a><wbr>(boolean newVal)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxNestingDepth(int)" class="member-name-link">withMaxNestingDepth</a><wbr>(int maxNestingDepth)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.ParserConfiguration">Methods inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#getMaxNestingDepth()">getMaxNestingDepth</a>, <a href="ParserConfiguration.html#isKeepStrings()">isKeepStrings</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="DEFAULT_MAXIMUM_NESTING_DEPTH">
|
||||
<h3>DEFAULT_MAXIMUM_NESTING_DEPTH</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_MAXIMUM_NESTING_DEPTH</span></div>
|
||||
<div class="block">We can override the default maximum nesting depth if needed.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.JSONMLParserConfiguration.DEFAULT_MAXIMUM_NESTING_DEPTH">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="ORIGINAL">
|
||||
<h3>ORIGINAL</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></span> <span class="element-name">ORIGINAL</span></div>
|
||||
<div class="block">Original Configuration of the XML to JSONML Parser.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="KEEP_STRINGS">
|
||||
<h3>KEEP_STRINGS</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></span> <span class="element-name">KEEP_STRINGS</span></div>
|
||||
<div class="block">Original configuration of the XML to JSONML Parser except that values are kept as strings.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>JSONMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONMLParserConfiguration</span>()</div>
|
||||
<div class="block">Default parser configuration. Does not keep strings (tries to implicitly convert values).</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(boolean,int)">
|
||||
<h3>JSONMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">JSONMLParserConfiguration</span><wbr><span class="parameters">(boolean keepStrings,
|
||||
int maxNestingDepth)</span></div>
|
||||
<div class="block">Configure the parser string processing and use the default CDATA Tag Name as "content".</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>keepStrings</code> - <code>true</code> to parse all values as string.
|
||||
<code>false</code> to try and convert XML string values into a JSON value.</dd>
|
||||
<dd><code>maxNestingDepth</code> - <code>int</code> to limit the nesting depth</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="clone()">
|
||||
<h3>clone</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></span> <span class="element-name">clone</span>()</div>
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#clone()">clone</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withKeepStrings(boolean)">
|
||||
<h3>withKeepStrings</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></span> <span class="element-name">withKeepStrings</span><wbr><span class="parameters">(boolean newVal)</span></div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ParserConfiguration.html#withKeepStrings(boolean)">ParserConfiguration</a></code></span></div>
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#withKeepStrings(boolean)">withKeepStrings</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>newVal</code> - new value to use for the <code>keepStrings</code> configuration option.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withMaxNestingDepth(int)">
|
||||
<h3>withMaxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></span> <span class="element-name">withMaxNestingDepth</span><wbr><span class="parameters">(int maxNestingDepth)</span></div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ParserConfiguration.html#withMaxNestingDepth(int)">ParserConfiguration</a></code></span></div>
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML. The default max nesting depth is 512, which means the parser
|
||||
will throw a JsonException if the maximum depth is reached.
|
||||
Using any negative value as a parameter is equivalent to setting no limit to the nesting depth,
|
||||
which means the parses will go as deep as the maximum call stack size allows.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#withMaxNestingDepth(int)">withMaxNestingDepth</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maxNestingDepth</code> - the maximum nesting depth allowed to the XML parser</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,210 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONParserConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONParserConfiguration">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONParserConfiguration" class="title">Class JSONParserConfiguration</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="ParserConfiguration.html" title="class in org.json">org.json.ParserConfiguration</a>
|
||||
<div class="inheritance">org.json.JSONParserConfiguration</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONParserConfiguration</span>
|
||||
<span class="extends-implements">extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></span></div>
|
||||
<div class="block">Configuration object for the JSON parser. The configuration is immutable.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-org.json.ParserConfiguration">Fields inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#DEFAULT_MAXIMUM_NESTING_DEPTH">DEFAULT_MAXIMUM_NESTING_DEPTH</a>, <a href="ParserConfiguration.html#keepStrings">keepStrings</a>, <a href="ParserConfiguration.html#maxNestingDepth">maxNestingDepth</a>, <a href="ParserConfiguration.html#UNDEFINED_MAXIMUM_NESTING_DEPTH">UNDEFINED_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JSONParserConfiguration</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Configuration with the default values.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxNestingDepth(int)" class="member-name-link">withMaxNestingDepth</a><wbr>(int maxNestingDepth)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.ParserConfiguration">Methods inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#getMaxNestingDepth()">getMaxNestingDepth</a>, <a href="ParserConfiguration.html#isKeepStrings()">isKeepStrings</a>, <a href="ParserConfiguration.html#withKeepStrings(boolean)">withKeepStrings</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>JSONParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONParserConfiguration</span>()</div>
|
||||
<div class="block">Configuration with the default values.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="clone()">
|
||||
<h3>clone</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></span> <span class="element-name">clone</span>()</div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ParserConfiguration.html#clone()">ParserConfiguration</a></code></span></div>
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#clone()">clone</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withMaxNestingDepth(int)">
|
||||
<h3>withMaxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></span> <span class="element-name">withMaxNestingDepth</span><wbr><span class="parameters">(int maxNestingDepth)</span></div>
|
||||
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="ParserConfiguration.html#withMaxNestingDepth(int)">ParserConfiguration</a></code></span></div>
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML. The default max nesting depth is 512, which means the parser
|
||||
will throw a JsonException if the maximum depth is reached.
|
||||
Using any negative value as a parameter is equivalent to setting no limit to the nesting depth,
|
||||
which means the parses will go as deep as the maximum call stack size allows.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#withMaxNestingDepth(int)">withMaxNestingDepth</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maxNestingDepth</code> - the maximum nesting depth allowed to the XML parser</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,220 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONPointer.Builder</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONPointer, class: Builder">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONPointer.Builder" class="title">Class JSONPointer.Builder</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.JSONPointer.Builder</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="JSONPointer.html" title="class in org.json">JSONPointer</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">JSONPointer.Builder</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">This class allows the user to build a JSONPointer in steps, using
|
||||
exactly one segment in each step.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Builder</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new Builder object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#append(int)" class="member-name-link">append</a><wbr>(int arrayIndex)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Adds an integer to the reference token list.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#append(java.lang.String)" class="member-name-link">append</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> token)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Adds an arbitrary token to the list of reference tokens.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONPointer.html" title="class in org.json">JSONPointer</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Creates a <code>JSONPointer</code> instance using the tokens previously set using the
|
||||
<a href="#append(java.lang.String)"><code>append(String)</code></a> method calls.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>Builder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Builder</span>()</div>
|
||||
<div class="block">Constructs a new Builder object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="build()">
|
||||
<h3>build</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONPointer.html" title="class in org.json">JSONPointer</a></span> <span class="element-name">build</span>()</div>
|
||||
<div class="block">Creates a <code>JSONPointer</code> instance using the tokens previously set using the
|
||||
<a href="#append(java.lang.String)"><code>append(String)</code></a> method calls.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>a JSONPointer object</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="append(java.lang.String)">
|
||||
<h3>append</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></span> <span class="element-name">append</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> token)</span></div>
|
||||
<div class="block">Adds an arbitrary token to the list of reference tokens. It can be any non-null value.
|
||||
|
||||
Unlike in the case of JSON string or URI fragment representation of JSON pointers, the
|
||||
argument of this method MUST NOT be escaped. If you want to query the property called
|
||||
<code>"a~b"</code> then you should simply pass the <code>"a~b"</code> string as-is, there is no
|
||||
need to escape it as <code>"a~0b"</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>token</code> - the new token to be appended to the list</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>this</code></dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if <code>token</code> is null</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="append(int)">
|
||||
<h3>append</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></span> <span class="element-name">append</span><wbr><span class="parameters">(int arrayIndex)</span></div>
|
||||
<div class="block">Adds an integer to the reference token list. Although not necessarily, mostly this token will
|
||||
denote an array index.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>arrayIndex</code> - the array index to be added to the token list</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>this</code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,293 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONPointer</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONPointer">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONPointer" class="title">Class JSONPointer</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.JSONPointer</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONPointer</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">A JSON Pointer is a simple query language defined for JSON documents by
|
||||
<a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a>.
|
||||
|
||||
In a nutshell, JSONPointer allows the user to navigate into a JSON document
|
||||
using strings, and retrieve targeted objects, like a simple form of XPATH.
|
||||
Path segments are separated by the '/' char, which signifies the root of
|
||||
the document when it appears as the first char of the string. Array
|
||||
elements are navigated using ordinals, counting from 0. JSONPointer strings
|
||||
may be extended to any arbitrary number of segments. If the navigation
|
||||
is successful, the matched item is returned. A matched item may be a
|
||||
JSONObject, a JSONArray, or a JSON value. If the JSONPointer string building
|
||||
fails, an appropriate exception is thrown. If the navigation fails to find
|
||||
a match, a JSONPointerException is thrown.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="caption"><span>Nested Classes</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static class </code></div>
|
||||
<div class="col-second even-row-color"><code><a href="JSONPointer.Builder.html" class="type-name-link" title="class in org.json">JSONPointer.Builder</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">This class allows the user to build a JSONPointer in steps, using
|
||||
exactly one segment in each step.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">JSONPointer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pointer)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Pre-parses and initializes a new <code>JSONPointer</code> instance.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.List)" class="member-name-link">JSONPointer</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> refTokens)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Constructs a new JSONPointer instance with the provided list of reference tokens.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Static factory method for <a href="JSONPointer.Builder.html" title="class in org.json"><code>JSONPointer.Builder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queryFrom(java.lang.Object)" class="member-name-link">queryFrom</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> document)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Evaluates this JSON Pointer on the given <code>document</code>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns a string representing the JSONPointer path value using string
|
||||
representation</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toURIFragment()" class="member-name-link">toURIFragment</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Returns a string representing the JSONPointer path value using URI
|
||||
fragment identifier representation</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>JSONPointer</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONPointer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pointer)</span></div>
|
||||
<div class="block">Pre-parses and initializes a new <code>JSONPointer</code> instance. If you want to
|
||||
evaluate the same JSON Pointer on different JSON documents then it is recommended
|
||||
to keep the <code>JSONPointer</code> instances due to performance considerations.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>pointer</code> - the JSON String or URI Fragment representation of the JSON pointer.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>pointer</code> is not a valid JSON pointer</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.util.List)">
|
||||
<h3>JSONPointer</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONPointer</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> refTokens)</span></div>
|
||||
<div class="block">Constructs a new JSONPointer instance with the provided list of reference tokens.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>refTokens</code> - A list of strings representing the reference tokens for the JSON Pointer.
|
||||
Each token identifies a step in the path to the targeted value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="builder()">
|
||||
<h3>builder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></span> <span class="element-name">builder</span>()</div>
|
||||
<div class="block">Static factory method for <a href="JSONPointer.Builder.html" title="class in org.json"><code>JSONPointer.Builder</code></a>. Example usage:
|
||||
|
||||
<pre><code>
|
||||
JSONPointer pointer = JSONPointer.builder()
|
||||
.append("obj")
|
||||
.append("other~key").append("another/key")
|
||||
.append("\"")
|
||||
.append(0)
|
||||
.build();
|
||||
</code></pre></div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>a builder instance which can be used to construct a <code>JSONPointer</code> instance by chained
|
||||
<a href="JSONPointer.Builder.html#append(java.lang.String)"><code>JSONPointer.Builder.append(String)</code></a> calls.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="queryFrom(java.lang.Object)">
|
||||
<h3>queryFrom</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">queryFrom</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> document)</span>
|
||||
throws <span class="exceptions"><a href="JSONPointerException.html" title="class in org.json">JSONPointerException</a></span></div>
|
||||
<div class="block">Evaluates this JSON Pointer on the given <code>document</code>. The <code>document</code>
|
||||
is usually a <a href="JSONObject.html" title="class in org.json"><code>JSONObject</code></a> or a <a href="JSONArray.html" title="class in org.json"><code>JSONArray</code></a> instance, but the empty
|
||||
JSON Pointer (<code>""</code>) can be evaluated on any JSON values and in such case the
|
||||
returned value will be <code>document</code> itself.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>document</code> - the JSON document which should be the subject of querying.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the result of the evaluation</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONPointerException.html" title="class in org.json">JSONPointerException</a></code> - if an error occurs during evaluation</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString()">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div>
|
||||
<div class="block">Returns a string representing the JSONPointer path value using string
|
||||
representation</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toURIFragment()">
|
||||
<h3>toURIFragment</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toURIFragment</span>()</div>
|
||||
<div class="block">Returns a string representing the JSONPointer path value using URI
|
||||
fragment identifier representation</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>a uri fragment string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,177 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONPointerException</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONPointerException">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li>Method</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONPointerException" class="title">Class JSONPointerException</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">java.lang.Throwable</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">java.lang.Exception</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link">java.lang.RuntimeException</a>
|
||||
<div class="inheritance"><a href="JSONException.html" title="class in org.json">org.json.JSONException</a>
|
||||
<div class="inheritance">org.json.JSONPointerException</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONPointerException</span>
|
||||
<span class="extends-implements">extends <a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">The JSONPointerException is thrown by <a href="JSONPointer.html" title="class in org.json"><code>JSONPointer</code></a> if an error occurs
|
||||
during evaluating a pointer.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../serialized-form.html#org.json.JSONPointerException">Serialized Form</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">JSONPointerException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new JSONPointerException with the specified error message.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">JSONPointerException</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Constructs a new JSONPointerException with the specified error message and cause.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Throwable">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#addSuppressed(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">addSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#fillInStackTrace()" title="class or interface in java.lang" class="external-link">fillInStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getCause()" title="class or interface in java.lang" class="external-link">getCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getLocalizedMessage()" title="class or interface in java.lang" class="external-link">getLocalizedMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getMessage()" title="class or interface in java.lang" class="external-link">getMessage</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getStackTrace()" title="class or interface in java.lang" class="external-link">getStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#getSuppressed()" title="class or interface in java.lang" class="external-link">getSuppressed</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#initCause(java.lang.Throwable)" title="class or interface in java.lang" class="external-link">initCause</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace()" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintStream)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#printStackTrace(java.io.PrintWriter)" title="class or interface in java.lang" class="external-link">printStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#setStackTrace(java.lang.StackTraceElement%5B%5D)" title="class or interface in java.lang" class="external-link">setStackTrace</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>JSONPointerException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONPointerException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div>
|
||||
<div class="block">Constructs a new JSONPointerException with the specified error message.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - The detail message describing the reason for the exception.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String,java.lang.Throwable)">
|
||||
<h3>JSONPointerException</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONPointerException</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div>
|
||||
<div class="block">Constructs a new JSONPointerException with the specified error message and cause.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - The detail message describing the reason for the exception.</dd>
|
||||
<dd><code>cause</code> - The cause of the exception.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,84 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONPropertyIgnore</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, annotation type: JSONPropertyIgnore">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Field | </li>
|
||||
<li>Optional | </li>
|
||||
<li>Required</li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Element</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Annotation Interface JSONPropertyIgnore" class="title">Annotation Interface JSONPropertyIgnore</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
|
||||
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">JSONPropertyIgnore</span></div>
|
||||
<div class="block">Use this annotation on a getter method to override the Bean name
|
||||
parser for Bean -> JSONObject mapping. If this annotation is
|
||||
present at any level in the class hierarchy, then the method will
|
||||
not be serialized from the bean into the JSONObject.</div>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,127 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONPropertyName</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, annotation type: JSONPropertyName">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Field | </li>
|
||||
<li>Optional | </li>
|
||||
<li><a href="#annotation-interface-required-element-summary">Required</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#annotation-interface-element-detail">Element</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Annotation Interface JSONPropertyName" class="title">Annotation Interface JSONPropertyName</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
|
||||
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">JSONPropertyName</span></div>
|
||||
<div class="block">Use this annotation on a getter method to override the Bean name
|
||||
parser for Bean -> JSONObject mapping. A value set to empty string <code>""</code>
|
||||
will have the Bean parser fall back to the default field name processing.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== ANNOTATION INTERFACE REQUIRED MEMBER SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="member-summary" id="annotation-interface-required-element-summary">
|
||||
<h2>Required Element Summary</h2>
|
||||
<div class="caption"><span>Required Elements</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Required Element</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#value()" class="member-name-link">value</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The value of the JSON property.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details" id="annotation-interface-element-detail">
|
||||
<ul class="details-list">
|
||||
<!-- ============ ANNOTATION INTERFACE MEMBER DETAIL =========== -->
|
||||
<li>
|
||||
<section class="member-details">
|
||||
<h2>Element Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="value()">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">value</span></div>
|
||||
<div class="block">The value of the JSON property.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The name of the property as to be used in the JSON Object.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,139 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONString</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, interface: JSONString">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Interface JSONString" class="title">Interface JSONString</h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">JSONString</span></div>
|
||||
<div class="block">The <code>JSONString</code> interface allows a <code>toJSONString()</code>
|
||||
method so that a class can change the behavior of
|
||||
<code>JSONObject.toString()</code>, <code>JSONArray.toString()</code>,
|
||||
and <code>JSONWriter.value(</code>Object<code>)</code>. The
|
||||
<code>toJSONString</code> method will be used instead of the default behavior
|
||||
of using the Object's <code>toString()</code> method and quoting the result.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toJSONString()" class="member-name-link">toJSONString</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">The <code>toJSONString</code> method allows a class to produce its own JSON
|
||||
serialization.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toJSONString()">
|
||||
<h3>toJSONString</h3>
|
||||
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toJSONString</span>()</div>
|
||||
<div class="block">The <code>toJSONString</code> method allows a class to produce its own JSON
|
||||
serialization.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A strictly syntactically correct JSON text.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,214 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONStringer</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONStringer">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONStringer" class="title">Class JSONStringer</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="JSONWriter.html" title="class in org.json">org.json.JSONWriter</a>
|
||||
<div class="inheritance">org.json.JSONStringer</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONStringer</span>
|
||||
<span class="extends-implements">extends <a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span></div>
|
||||
<div class="block">JSONStringer provides a quick and convenient way of producing JSON text.
|
||||
The texts produced strictly conform to JSON syntax rules. No whitespace is
|
||||
added, so the results are ready for transmission or storage. Each instance of
|
||||
JSONStringer can produce one JSON text.
|
||||
<p>
|
||||
A JSONStringer instance provides a <code>value</code> method for appending
|
||||
values to the
|
||||
text, and a <code>key</code>
|
||||
method for adding keys before values in objects. There are <code>array</code>
|
||||
and <code>endArray</code> methods that make and bound array values, and
|
||||
<code>object</code> and <code>endObject</code> methods which make and bound
|
||||
object values. All of these methods return the JSONWriter instance,
|
||||
permitting cascade style. For example, <pre>
|
||||
myString = new JSONStringer()
|
||||
.object()
|
||||
.key("JSON")
|
||||
.value("Hello, World!")
|
||||
.endObject()
|
||||
.toString();</pre> which produces the string <pre>
|
||||
{"JSON":"Hello, World!"}</pre>
|
||||
<p>
|
||||
The first method called must be <code>array</code> or <code>object</code>.
|
||||
There are no methods for adding commas or colons. JSONStringer adds them for
|
||||
you. Objects and arrays can be nested up to 200 levels deep.
|
||||
<p>
|
||||
This can sometimes be easier than using a JSONObject to build a string.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-org.json.JSONWriter">Fields inherited from class org.json.<a href="JSONWriter.html" title="class in org.json">JSONWriter</a></h3>
|
||||
<code><a href="JSONWriter.html#mode">mode</a>, <a href="JSONWriter.html#writer">writer</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">JSONStringer</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Make a fresh JSONStringer.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Return the JSON text.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.JSONWriter">Methods inherited from class org.json.<a href="JSONWriter.html" title="class in org.json">JSONWriter</a></h3>
|
||||
<code><a href="JSONWriter.html#array()">array</a>, <a href="JSONWriter.html#endArray()">endArray</a>, <a href="JSONWriter.html#endObject()">endObject</a>, <a href="JSONWriter.html#key(java.lang.String)">key</a>, <a href="JSONWriter.html#object()">object</a>, <a href="JSONWriter.html#value(boolean)">value</a>, <a href="JSONWriter.html#value(double)">value</a>, <a href="JSONWriter.html#value(long)">value</a>, <a href="JSONWriter.html#value(java.lang.Object)">value</a>, <a href="JSONWriter.html#valueToString(java.lang.Object)">valueToString</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>JSONStringer</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONStringer</span>()</div>
|
||||
<div class="block">Make a fresh JSONStringer. It can be used to build one JSON text.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toString()">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div>
|
||||
<div class="block">Return the JSON text. This method is used to obtain the product of the
|
||||
JSONStringer instance. It will return <code>null</code> if there was a
|
||||
problem in the construction of the JSON text (such as the calls to
|
||||
<code>array</code> were not properly balanced with calls to
|
||||
<code>endArray</code>).</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The JSON text.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,561 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONTokener</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONTokener">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONTokener" class="title">Class JSONTokener</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.JSONTokener</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="HTTPTokener.html" title="class in org.json">HTTPTokener</a></code>, <code><a href="XMLTokener.html" title="class in org.json">XMLTokener</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONTokener</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">A JSONTokener takes a source string and extracts characters and tokens from
|
||||
it. It is used by the JSONObject and JSONArray constructors to parse
|
||||
JSON source strings.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.InputStream)" class="member-name-link">JSONTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> inputStream)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct a JSONTokener from an InputStream.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.io.Reader)" class="member-name-link">JSONTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Construct a JSONTokener from a Reader.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">JSONTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct a JSONTokener from a string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#back()" class="member-name-link">back</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Back up one character.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Closes the underlying reader, releasing any resources associated with it.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dehexchar(char)" class="member-name-link">dehexchar</a><wbr>(char c)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Get the hex value of a character (base16).</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end()" class="member-name-link">end</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Checks if the end of the input has been reached.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected char</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPrevious()" class="member-name-link">getPrevious</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the last character read from the input or '\0' if nothing has been read yet.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#more()" class="member-name-link">more</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Determine if the source string still contains characters that next()
|
||||
can consume.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next character in the source string.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next(char)" class="member-name-link">next</a><wbr>(char c)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Consume the next character, and check that it matches a specified
|
||||
character.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next(int)" class="member-name-link">next</a><wbr>(int n)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next n characters.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextClean()" class="member-name-link">nextClean</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next char in the string, skipping whitespace.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextString(char)" class="member-name-link">nextString</a><wbr>(char quote)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Return the characters up to the next close quote character.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextTo(char)" class="member-name-link">nextTo</a><wbr>(char delimiter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the text up but not including the specified character or the
|
||||
end of line, whichever comes first.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextTo(java.lang.String)" class="member-name-link">nextTo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> delimiters)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the text up but not including one of the specified delimiter
|
||||
characters or the end of line, whichever comes first.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextValue()" class="member-name-link">nextValue</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next value.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>char</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#skipTo(char)" class="member-name-link">skipTo</a><wbr>(char to)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Skip characters until the next character is the requested character.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONException.html" title="class in org.json">JSONException</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syntaxError(java.lang.String)" class="member-name-link">syntaxError</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Make a JSONException to signal a syntax error.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONException.html" title="class in org.json">JSONException</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#syntaxError(java.lang.String,java.lang.Throwable)" class="member-name-link">syntaxError</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> causedBy)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Make a JSONException to signal a syntax error.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Make a printable string of this JSONTokener.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.io.Reader)">
|
||||
<h3>JSONTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader)</span></div>
|
||||
<div class="block">Construct a JSONTokener from a Reader. The caller must close the Reader.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>reader</code> - A reader.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.io.InputStream)">
|
||||
<h3>JSONTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> inputStream)</span></div>
|
||||
<div class="block">Construct a JSONTokener from an InputStream. The caller must close the input stream.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>inputStream</code> - The source.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>JSONTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
||||
<div class="block">Construct a JSONTokener from a string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>s</code> - A source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="back()">
|
||||
<h3>back</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">back</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Back up one character. This provides a sort of lookahead capability,
|
||||
so that you can test for a digit or letter before attempting to parse
|
||||
the next number or identifier.</div>
|
||||
<dl class="notes">
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if trying to step back more than 1 step
|
||||
or if already at the start of the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="dehexchar(char)">
|
||||
<h3>dehexchar</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name">dehexchar</span><wbr><span class="parameters">(char c)</span></div>
|
||||
<div class="block">Get the hex value of a character (base16).</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>c</code> - A character between '0' and '9' or between 'A' and 'F' or
|
||||
between 'a' and 'f'.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An int between 0 and 15, or -1 if c was not a hex digit.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="end()">
|
||||
<h3>end</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">end</span>()</div>
|
||||
<div class="block">Checks if the end of the input has been reached.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if at the end of the file and we didn't step back</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="more()">
|
||||
<h3>more</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">more</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Determine if the source string still contains characters that next()
|
||||
can consume.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>true if not yet at the end of the source.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - thrown if there is an error stepping forward
|
||||
or backward while checking for more data.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="next()">
|
||||
<h3>next</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">next</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next character in the source string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The next character, or 0 if past the end of the source string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error reading the source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getPrevious()">
|
||||
<h3>getPrevious</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">char</span> <span class="element-name">getPrevious</span>()</div>
|
||||
<div class="block">Get the last character read from the input or '\0' if nothing has been read yet.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the last character read from the input.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="next(char)">
|
||||
<h3>next</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">next</span><wbr><span class="parameters">(char c)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Consume the next character, and check that it matches a specified
|
||||
character.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>c</code> - The character to match.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The character.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if the character does not match.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="next(int)">
|
||||
<h3>next</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">next</span><wbr><span class="parameters">(int n)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next n characters.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>n</code> - The number of characters to take.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string of n characters.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Substring bounds error if there are not
|
||||
n characters remaining in the source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextClean()">
|
||||
<h3>nextClean</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">nextClean</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next char in the string, skipping whitespace.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A character, or 0 if there are no more characters.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error reading the source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextString(char)">
|
||||
<h3>nextString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nextString</span><wbr><span class="parameters">(char quote)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Return the characters up to the next close quote character.
|
||||
Backslash processing is done. The formal JSON format does not
|
||||
allow strings in single quotes, but an implementation is allowed to
|
||||
accept them.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>quote</code> - The quoting character, either
|
||||
<code>"</code> <small>(double quote)</small> or
|
||||
<code>'</code> <small>(single quote)</small>.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A String.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Unterminated string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextTo(char)">
|
||||
<h3>nextTo</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nextTo</span><wbr><span class="parameters">(char delimiter)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the text up but not including the specified character or the
|
||||
end of line, whichever comes first.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>delimiter</code> - A delimiter character.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error while searching
|
||||
for the delimiter</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextTo(java.lang.String)">
|
||||
<h3>nextTo</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nextTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> delimiters)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the text up but not including one of the specified delimiter
|
||||
characters or the end of line, whichever comes first.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>delimiters</code> - A set of delimiter characters.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string, trimmed.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error while searching
|
||||
for the delimiter</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextValue()">
|
||||
<h3>nextValue</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">nextValue</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next value. The value can be a Boolean, Double, Integer,
|
||||
JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>An object.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If syntax error.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="skipTo(char)">
|
||||
<h3>skipTo</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">char</span> <span class="element-name">skipTo</span><wbr><span class="parameters">(char to)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Skip characters until the next character is the requested character.
|
||||
If the requested character is not found, no characters are skipped.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>to</code> - A character to skip to.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The requested character, or zero if the requested character
|
||||
is not found.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error while searching
|
||||
for the to character</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="syntaxError(java.lang.String)">
|
||||
<h3>syntaxError</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONException.html" title="class in org.json">JSONException</a></span> <span class="element-name">syntaxError</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span></div>
|
||||
<div class="block">Make a JSONException to signal a syntax error.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - The error message.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONException object, suitable for throwing</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="syntaxError(java.lang.String,java.lang.Throwable)">
|
||||
<h3>syntaxError</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONException.html" title="class in org.json">JSONException</a></span> <span class="element-name">syntaxError</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> causedBy)</span></div>
|
||||
<div class="block">Make a JSONException to signal a syntax error.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>message</code> - The error message.</dd>
|
||||
<dd><code>causedBy</code> - The throwable that caused the error.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONException object, suitable for throwing</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString()">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div>
|
||||
<div class="block">Make a printable string of this JSONTokener.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>" at {index} [character {character} line {line}]"</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="close()">
|
||||
<h3>close</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()
|
||||
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
|
||||
<div class="block">Closes the underlying reader, releasing any resources associated with it.</div>
|
||||
<dl class="notes">
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If an I/O error occurs while closing the reader.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,466 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>JSONWriter</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: JSONWriter">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class JSONWriter" class="title">Class JSONWriter</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.JSONWriter</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="JSONStringer.html" title="class in org.json">JSONStringer</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JSONWriter</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">JSONWriter provides a quick and convenient way of producing JSON text.
|
||||
The texts produced strictly conform to JSON syntax rules. No whitespace is
|
||||
added, so the results are ready for transmission or storage. Each instance of
|
||||
JSONWriter can produce one JSON text.
|
||||
<p>
|
||||
A JSONWriter instance provides a <code>value</code> method for appending
|
||||
values to the
|
||||
text, and a <code>key</code>
|
||||
method for adding keys before values in objects. There are <code>array</code>
|
||||
and <code>endArray</code> methods that make and bound array values, and
|
||||
<code>object</code> and <code>endObject</code> methods which make and bound
|
||||
object values. All of these methods return the JSONWriter instance,
|
||||
permitting a cascade style. For example, <pre>
|
||||
new JSONWriter(myWriter)
|
||||
.object()
|
||||
.key("JSON")
|
||||
.value("Hello, World!")
|
||||
.endObject();</pre> which writes <pre>
|
||||
{"JSON":"Hello, World!"}</pre>
|
||||
<p>
|
||||
The first method called must be <code>array</code> or <code>object</code>.
|
||||
There are no methods for adding commas or colons. JSONWriter adds them for
|
||||
you. Objects and arrays can be nested up to 200 levels deep.
|
||||
<p>
|
||||
This can sometimes be easier than using a JSONObject to build a string.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>protected char</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#mode" class="member-name-link">mode</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The current mode.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#writer" class="member-name-link">writer</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The writer that will receive the output.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.Appendable)" class="member-name-link">JSONWriter</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> w)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Make a fresh JSONWriter.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#array()" class="member-name-link">array</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Begin appending a new array.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endArray()" class="member-name-link">endArray</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">End an array.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endObject()" class="member-name-link">endObject</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">End an object.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#key(java.lang.String)" class="member-name-link">key</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Append a key.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#object()" class="member-name-link">object</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Begin appending a new object.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#value(boolean)" class="member-name-link">value</a><wbr>(boolean b)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Append either the value <code>true</code> or the value
|
||||
<code>false</code>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#value(double)" class="member-name-link">value</a><wbr>(double d)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Append a double value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#value(long)" class="member-name-link">value</a><wbr>(long l)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Append a long value.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#value(java.lang.Object)" class="member-name-link">value</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Append an object value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueToString(java.lang.Object)" class="member-name-link">valueToString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Make a JSON text of an Object value.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="mode">
|
||||
<h3>mode</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">char</span> <span class="element-name">mode</span></div>
|
||||
<div class="block">The current mode. Values:
|
||||
'a' (array),
|
||||
'd' (done),
|
||||
'i' (initial),
|
||||
'k' (key),
|
||||
'o' (object).</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="writer">
|
||||
<h3>writer</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a></span> <span class="element-name">writer</span></div>
|
||||
<div class="block">The writer that will receive the output.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.Appendable)">
|
||||
<h3>JSONWriter</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JSONWriter</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a> w)</span></div>
|
||||
<div class="block">Make a fresh JSONWriter. It can be used to build one JSON text.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>w</code> - an appendable object</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="array()">
|
||||
<h3>array</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">array</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Begin appending a new array. All values until the balancing
|
||||
<code>endArray</code> will be appended to this array. The
|
||||
<code>endArray</code> method must be called to mark the array's end.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the nesting is too deep, or if the object is
|
||||
started in the wrong place (for example as a key or after the end of the
|
||||
outermost array or object).</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="endArray()">
|
||||
<h3>endArray</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">endArray</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">End an array. This method most be called to balance calls to
|
||||
<code>array</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If incorrectly nested.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="endObject()">
|
||||
<h3>endObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">endObject</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">End an object. This method most be called to balance calls to
|
||||
<code>object</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If incorrectly nested.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="key(java.lang.String)">
|
||||
<h3>key</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">key</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Append a key. The key will be associated with the next value. In an
|
||||
object, every value must be preceded by a key.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - A key string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the key is out of place. For example, keys
|
||||
do not belong in arrays or if the key is null.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="object()">
|
||||
<h3>object</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">object</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Begin appending a new object. All keys and values until the balancing
|
||||
<code>endObject</code> will be appended to this object. The
|
||||
<code>endObject</code> method must be called to mark the object's end.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the nesting is too deep, or if the object is
|
||||
started in the wrong place (for example as a key or after the end of the
|
||||
outermost array or object).</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="valueToString(java.lang.Object)">
|
||||
<h3>valueToString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">valueToString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Make a JSON text of an Object value. If the object has an
|
||||
value.toJSONString() method, then that method will be used to produce the
|
||||
JSON text. The method is required to produce a strictly conforming text.
|
||||
If the object does not contain a toJSONString method (which is the most
|
||||
common case), then a text will be produced by other means. If the value
|
||||
is an array or Collection, then a JSONArray will be made from it and its
|
||||
toJSONString method will be called. If the value is a MAP, then a
|
||||
JSONObject will be made from it and its toJSONString method will be
|
||||
called. Otherwise, the value's toString method will be called, and the
|
||||
result will be quoted.
|
||||
|
||||
<p>
|
||||
Warning: This method assumes that the data structure is acyclical.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>value</code> - The value to be serialized.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>a printable, displayable, transmittable representation of the
|
||||
object, beginning with <code>{</code> <small>(left
|
||||
brace)</small> and ending with <code>}</code> <small>(right
|
||||
brace)</small>.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the value is or contains an invalid number.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="value(boolean)">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">value</span><wbr><span class="parameters">(boolean b)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Append either the value <code>true</code> or the value
|
||||
<code>false</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>b</code> - A boolean.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="value(double)">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">value</span><wbr><span class="parameters">(double d)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Append a double value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>d</code> - A double.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the number is not finite.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="value(long)">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">value</span><wbr><span class="parameters">(long l)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Append a long value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>l</code> - A long.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="value(java.lang.Object)">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></span> <span class="element-name">value</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Append an object value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - The object to append. It can be null, or a Boolean, Number,
|
||||
String, JSONObject, or JSONArray, or an object that implements JSONString.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>this</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the value is out of sequence.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,363 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>ParserConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: ParserConfiguration">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class ParserConfiguration" class="title">Class ParserConfiguration</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.ParserConfiguration</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Direct Known Subclasses:</dt>
|
||||
<dd><code><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></code>, <code><a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></code>, <code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ParserConfiguration</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Configuration base object for parsers. The configuration is immutable.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#DEFAULT_MAXIMUM_NESTING_DEPTH" class="member-name-link">DEFAULT_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The default maximum nesting depth when parsing a document.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>protected boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#keepStrings" class="member-name-link">keepStrings</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>protected int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#maxNestingDepth" class="member-name-link">maxNestingDepth</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The maximum nesting depth when parsing a document.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#UNDEFINED_MAXIMUM_NESTING_DEPTH" class="member-name-link">UNDEFINED_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Used to indicate there's no defined limit to the maximum nesting depth when parsing a document.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier</div>
|
||||
<div class="table-header col-second">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code> </code></div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ParserConfiguration</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new ParserConfiguration with default settings.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>protected </code></div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean,int)" class="member-name-link">ParserConfiguration</a><wbr>(boolean keepStrings,
|
||||
int maxNestingDepth)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Constructs a new ParserConfiguration with the specified settings.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxNestingDepth()" class="member-name-link">getMaxNestingDepth</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">The maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isKeepStrings()" class="member-name-link">isKeepStrings</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a>><br>T</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withKeepStrings(boolean)" class="member-name-link">withKeepStrings</a><wbr>(boolean newVal)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a>><br>T</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxNestingDepth(int)" class="member-name-link">withMaxNestingDepth</a><wbr>(int maxNestingDepth)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="UNDEFINED_MAXIMUM_NESTING_DEPTH">
|
||||
<h3>UNDEFINED_MAXIMUM_NESTING_DEPTH</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">UNDEFINED_MAXIMUM_NESTING_DEPTH</span></div>
|
||||
<div class="block">Used to indicate there's no defined limit to the maximum nesting depth when parsing a document.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.ParserConfiguration.UNDEFINED_MAXIMUM_NESTING_DEPTH">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="DEFAULT_MAXIMUM_NESTING_DEPTH">
|
||||
<h3>DEFAULT_MAXIMUM_NESTING_DEPTH</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">DEFAULT_MAXIMUM_NESTING_DEPTH</span></div>
|
||||
<div class="block">The default maximum nesting depth when parsing a document.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.ParserConfiguration.DEFAULT_MAXIMUM_NESTING_DEPTH">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="keepStrings">
|
||||
<h3>keepStrings</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">keepStrings</span></div>
|
||||
<div class="block">Specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="maxNestingDepth">
|
||||
<h3>maxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">int</span> <span class="element-name">maxNestingDepth</span></div>
|
||||
<div class="block">The maximum nesting depth when parsing a document.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>ParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ParserConfiguration</span>()</div>
|
||||
<div class="block">Constructs a new ParserConfiguration with default settings.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(boolean,int)">
|
||||
<h3>ParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">ParserConfiguration</span><wbr><span class="parameters">(boolean keepStrings,
|
||||
int maxNestingDepth)</span></div>
|
||||
<div class="block">Constructs a new ParserConfiguration with the specified settings.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>keepStrings</code> - A boolean indicating whether to preserve strings during parsing.</dd>
|
||||
<dd><code>maxNestingDepth</code> - An integer representing the maximum allowed nesting depth.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="clone()">
|
||||
<h3>clone</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></span> <span class="element-name">clone</span>()</div>
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="isKeepStrings()">
|
||||
<h3>isKeepStrings</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isKeepStrings</span>()</div>
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <code>keepStrings</code> configuration value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withKeepStrings(boolean)">
|
||||
<h3>withKeepStrings</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a>></span> <span class="return-type">T</span> <span class="element-name">withKeepStrings</span><wbr><span class="parameters">(boolean newVal)</span></div>
|
||||
<div class="block">When parsing the XML into JSONML, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - the type of the configuration object</dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>newVal</code> - new value to use for the <code>keepStrings</code> configuration option.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getMaxNestingDepth()">
|
||||
<h3>getMaxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxNestingDepth</span>()</div>
|
||||
<div class="block">The maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>the maximum nesting depth set for this configuration</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withMaxNestingDepth(int)">
|
||||
<h3>withMaxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a>></span> <span class="return-type">T</span> <span class="element-name">withMaxNestingDepth</span><wbr><span class="parameters">(int maxNestingDepth)</span></div>
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSONML. The default max nesting depth is 512, which means the parser
|
||||
will throw a JsonException if the maximum depth is reached.
|
||||
Using any negative value as a parameter is equivalent to setting no limit to the nesting depth,
|
||||
which means the parses will go as deep as the maximum call stack size allows.</div>
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - the type of the configuration object</dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maxNestingDepth</code> - the maximum nesting depth allowed to the XML parser</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,195 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>Property</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: Property">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class Property" class="title">Class Property</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.Property</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Property</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Converts a Property file data into JSONObject and back.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Property</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new Property object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.util.Properties)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Converts a property file object into a JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toProperties(org.json.JSONObject)" class="member-name-link">toProperties</a><wbr>(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Converts the JSONObject into a property file object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>Property</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Property</span>()</div>
|
||||
<div class="block">Constructs a new Property object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.util.Properties)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Converts a property file object into a JSONObject. The property file object is a table of name value pairs.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>properties</code> - java.util.Properties</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>JSONObject</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toProperties(org.json.JSONObject)">
|
||||
<h3>toProperties</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a></span> <span class="element-name">toProperties</span><wbr><span class="parameters">(<a href="JSONObject.html" title="class in org.json">JSONObject</a> jo)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Converts the JSONObject into a property file object.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>jo</code> - JSONObject</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>java.util.Properties</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,787 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>XML</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: XML">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class XML" class="title">Class XML</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">org.json.XML</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">XML</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">This provides static methods to convert an XML text into a JSONObject, and to
|
||||
covert a JSONObject into an XML text.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#AMP" class="member-name-link">AMP</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The Character '&'.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#APOS" class="member-name-link">APOS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The Character '''.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#BANG" class="member-name-link">BANG</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The Character '!'.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#EQ" class="member-name-link">EQ</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The Character '='.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#GT" class="member-name-link">GT</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The Character</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#LT" class="member-name-link">LT</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The Character '<'.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#NULL_ATTR" class="member-name-link">NULL_ATTR</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Null attribute name</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#QUEST" class="member-name-link">QUEST</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The Character '?'.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#QUOT" class="member-name-link">QUOT</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The Character '"'.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#SLASH" class="member-name-link">SLASH</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The Character '/'.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#TYPE_ATTR" class="member-name-link">TYPE_ATTR</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Represents the XML attribute name for specifying type information.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">XML</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a new XML object.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#escape(java.lang.String)" class="member-name-link">escape</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Replace special characters with XML escapes:</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#noSpace(java.lang.String)" class="member-name-link">noSpace</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Throw an exception if the string contains whitespace.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringToValue(java.lang.String)" class="member-name-link">stringToValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">This method is the same as <a href="JSONObject.html#stringToValue(java.lang.String)"><code>JSONObject.stringToValue(String)</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringToValue(java.lang.String,org.json.XMLXsiTypeConverter)" class="member-name-link">stringToValue</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?> typeConverter)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">This method tries to convert the given string value to the target object</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.io.Reader)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.io.Reader,boolean)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.io.Reader,org.json.XMLParserConfiguration)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String,boolean)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="JSONObject.html" title="class in org.json">JSONObject</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toJSONObject(java.lang.String,org.json.XMLParserConfiguration)" class="member-name-link">toJSONObject</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object,int)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
int indentFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object,java.lang.String)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object,java.lang.String,int)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
int indentFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object,java.lang.String,org.json.XMLParserConfiguration)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toString(java.lang.Object,java.lang.String,org.json.XMLParserConfiguration,int)" class="member-name-link">toString</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config,
|
||||
int indentFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unescape(java.lang.String)" class="member-name-link">unescape</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Removes XML escapes from the string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="AMP">
|
||||
<h3>AMP</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">AMP</span></div>
|
||||
<div class="block">The Character '&'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="APOS">
|
||||
<h3>APOS</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">APOS</span></div>
|
||||
<div class="block">The Character '''.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="BANG">
|
||||
<h3>BANG</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">BANG</span></div>
|
||||
<div class="block">The Character '!'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="EQ">
|
||||
<h3>EQ</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">EQ</span></div>
|
||||
<div class="block">The Character '='.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="GT">
|
||||
<h3>GT</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">GT</span></div>
|
||||
<div class="block">The Character <pre><code>'>'. </code></pre></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="LT">
|
||||
<h3>LT</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">LT</span></div>
|
||||
<div class="block">The Character '<'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="QUEST">
|
||||
<h3>QUEST</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">QUEST</span></div>
|
||||
<div class="block">The Character '?'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="QUOT">
|
||||
<h3>QUOT</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">QUOT</span></div>
|
||||
<div class="block">The Character '"'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="SLASH">
|
||||
<h3>SLASH</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a></span> <span class="element-name">SLASH</span></div>
|
||||
<div class="block">The Character '/'.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="NULL_ATTR">
|
||||
<h3>NULL_ATTR</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">NULL_ATTR</span></div>
|
||||
<div class="block">Null attribute name</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.XML.NULL_ATTR">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="TYPE_ATTR">
|
||||
<h3>TYPE_ATTR</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">TYPE_ATTR</span></div>
|
||||
<div class="block">Represents the XML attribute name for specifying type information.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#org.json.XML.TYPE_ATTR">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>XML</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XML</span>()</div>
|
||||
<div class="block">Constructs a new XML object.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="escape(java.lang.String)">
|
||||
<h3>escape</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">escape</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Replace special characters with XML escapes:
|
||||
|
||||
<pre><code>
|
||||
&amp; (ampersand) is replaced by &amp;amp;
|
||||
&lt; (less than) is replaced by &amp;lt;
|
||||
&gt; (greater than) is replaced by &amp;gt;
|
||||
&quot; (double quote) is replaced by &amp;quot;
|
||||
&apos; (single quote / apostrophe) is replaced by &amp;apos;
|
||||
</code></pre></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The string to be escaped.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The escaped string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="unescape(java.lang.String)">
|
||||
<h3>unescape</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">unescape</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">Removes XML escapes from the string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - string to remove escapes from</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>string with converted entities</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="noSpace(java.lang.String)">
|
||||
<h3>noSpace</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">noSpace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Throw an exception if the string contains whitespace. Whitespace is not
|
||||
allowed in tagNames and attributes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if the string contains whitespace or is empty.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stringToValue(java.lang.String,org.json.XMLXsiTypeConverter)">
|
||||
<h3>stringToValue</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">stringToValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?> typeConverter)</span></div>
|
||||
<div class="block">This method tries to convert the given string value to the target object</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - String to convert</dd>
|
||||
<dd><code>typeConverter</code> - value converter to convert string to integer, boolean e.t.c</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>JSON value of this string or the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="stringToValue(java.lang.String)">
|
||||
<h3>stringToValue</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">stringToValue</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span></div>
|
||||
<div class="block">This method is the same as <a href="JSONObject.html#stringToValue(java.lang.String)"><code>JSONObject.stringToValue(String)</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - String to convert</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>JSON value of this string or the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.io.Reader)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>reader</code> - The XML source reader.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.io.Reader,boolean)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.
|
||||
|
||||
All values are converted as strings, for 1, 01, 29.0 will not be coerced to
|
||||
numbers but will instead be the exact value as seen in the XML document.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>reader</code> - The XML source reader.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.io.Reader,org.json.XMLParserConfiguration)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> reader,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.
|
||||
|
||||
All values are converted as strings, for 1, 01, 29.0 will not be coerced to
|
||||
numbers but will instead be the exact value as seen in the XML document.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>reader</code> - The XML source reader.</dd>
|
||||
<dd><code>config</code> - Configuration options for the parser</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String,boolean)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
boolean keepStrings)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.
|
||||
|
||||
All values are converted as strings, for 1, 01, 29.0 will not be coerced to
|
||||
numbers but will instead be the exact value as seen in the XML document.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dd><code>keepStrings</code> - If true, then values will not be coerced into boolean
|
||||
or numeric values and will instead be left as strings</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toJSONObject(java.lang.String,org.json.XMLParserConfiguration)">
|
||||
<h3>toJSONObject</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="JSONObject.html" title="class in org.json">JSONObject</a></span> <span class="element-name">toJSONObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> string,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a well-formed (but not necessarily valid) XML string into a
|
||||
JSONObject. Some information may be lost in this transformation because
|
||||
JSON is a data format and XML is a document format. XML uses elements,
|
||||
attributes, and content text, while JSON uses unordered collections of
|
||||
name/value pairs and arrays of values. JSON does not does not like to
|
||||
distinguish between elements and attributes. Sequences of similar
|
||||
elements are represented as JSONArrays. Content text may be placed in a
|
||||
"content" member. Comments, prologs, DTDs, and <pre><code>
|
||||
&lt;[ [ ]]></code></pre>
|
||||
are ignored.
|
||||
|
||||
All values are converted as strings, for 1, 01, 29.0 will not be coerced to
|
||||
numbers but will instead be the exact value as seen in the XML document.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>string</code> - The source string.</dd>
|
||||
<dd><code>config</code> - Configuration options for the parser.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A JSONObject containing the structured data from the XML string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an errors while parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object,java.lang.String)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName)</span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dd><code>tagName</code> - The optional name of the enclosing tag.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object,java.lang.String,org.json.XMLParserConfiguration)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dd><code>tagName</code> - The optional name of the enclosing tag.</dd>
|
||||
<dd><code>config</code> - Configuration that can control output to XML.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object,int)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
int indentFactor)</span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dd><code>indentFactor</code> - The number of spaces to add to each level of indentation.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object,java.lang.String,int)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
int indentFactor)</span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dd><code>tagName</code> - The optional name of the enclosing tag.</dd>
|
||||
<dd><code>indentFactor</code> - The number of spaces to add to each level of indentation.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="toString(java.lang.Object,java.lang.String,org.json.XMLParserConfiguration,int)">
|
||||
<h3>toString</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tagName,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> config,
|
||||
int indentFactor)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Convert a JSONObject into a well-formed, pretty printed element-normal XML string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>object</code> - A JSONObject.</dd>
|
||||
<dd><code>tagName</code> - The optional name of the enclosing tag.</dd>
|
||||
<dd><code>config</code> - Configuration that can control output to XML.</dd>
|
||||
<dd><code>indentFactor</code> - The number of spaces to add to each level of indentation.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - Thrown if there is an error parsing the string</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,618 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>XMLParserConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: XMLParserConfiguration">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class XMLParserConfiguration" class="title">Class XMLParserConfiguration</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="ParserConfiguration.html" title="class in org.json">org.json.ParserConfiguration</a>
|
||||
<div class="inheritance">org.json.XMLParserConfiguration</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">XMLParserConfiguration</span>
|
||||
<span class="extends-implements">extends <a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></span></div>
|
||||
<div class="block">Configuration object for the XML parser. The configuration is immutable.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#KEEP_STRINGS" class="member-name-link">KEEP_STRINGS</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Original configuration of the XML Parser except that values are kept as strings.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static final <a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#ORIGINAL" class="member-name-link">ORIGINAL</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Original Configuration of the XML Parser.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-org.json.ParserConfiguration">Fields inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#DEFAULT_MAXIMUM_NESTING_DEPTH">DEFAULT_MAXIMUM_NESTING_DEPTH</a>, <a href="ParserConfiguration.html#keepStrings">keepStrings</a>, <a href="ParserConfiguration.html#maxNestingDepth">maxNestingDepth</a>, <a href="ParserConfiguration.html#UNDEFINED_MAXIMUM_NESTING_DEPTH">UNDEFINED_MAXIMUM_NESTING_DEPTH</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">XMLParserConfiguration</a>()</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Default parser configuration.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean)" class="member-name-link">XMLParserConfiguration</a><wbr>(boolean keepStrings)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(boolean,java.lang.String)" class="member-name-link">XMLParserConfiguration</a><wbr>(boolean keepStrings,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(boolean,java.lang.String,boolean)" class="member-name-link">XMLParserConfiguration</a><wbr>(boolean keepStrings,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName,
|
||||
boolean convertNilAttributeToNull)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">XMLParserConfiguration</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getcDataTagName()" class="member-name-link">getcDataTagName</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">The name of the key in a JSON Object that indicates a CDATA section.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getForceList()" class="member-name-link">getForceList</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies that tags that will be converted to arrays
|
||||
in this configuration <code>Set<String></code> to parse the provided tags' values as arrays</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getXsiTypeMap()" class="member-name-link">getXsiTypeMap</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies that the values with attribute xsi:type
|
||||
will be converted to target type defined to client in this configuration
|
||||
<code>Map<String, XMLXsiTypeConverter<?>></code> to parse values with attribute
|
||||
xsi:type="integer" as integer, xsi:type="string" as string</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCloseEmptyTag()" class="member-name-link">isCloseEmptyTag</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Checks if the parser should automatically close empty XML tags.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isConvertNilAttributeToNull()" class="member-name-link">isConvertNilAttributeToNull</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies if values with attribute xsi:nil="true"
|
||||
should be kept as attribute(<code>false</code>), or they should be converted to
|
||||
<code>null</code>(<code>true</code>)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldTrimWhiteSpace()" class="member-name-link">shouldTrimWhiteSpace</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Checks if the parser should trim white spaces from XML content.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withcDataTagName(java.lang.String)" class="member-name-link">withcDataTagName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newVal)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">The name of the key in a JSON Object that indicates a CDATA section.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withCloseEmptyTag(boolean)" class="member-name-link">withCloseEmptyTag</a><wbr>(boolean closeEmptyTag)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">To enable explicit end tag with empty value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withConvertNilAttributeToNull(boolean)" class="member-name-link">withConvertNilAttributeToNull</a><wbr>(boolean newVal)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies if values with attribute xsi:nil="true"
|
||||
should be kept as attribute(<code>false</code>), or they should be converted to
|
||||
<code>null</code>(<code>true</code>)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withForceList(java.util.Set)" class="member-name-link">withForceList</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> forceList)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies that tags that will be converted to arrays
|
||||
in this configuration <code>Set<String></code> to parse the provided tags' values as arrays</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withKeepStrings(boolean)" class="member-name-link">withKeepStrings</a><wbr>(boolean newVal)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withMaxNestingDepth(int)" class="member-name-link">withMaxNestingDepth</a><wbr>(int maxNestingDepth)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSON.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withShouldTrimWhitespace(boolean)" class="member-name-link">withShouldTrimWhitespace</a><wbr>(boolean shouldTrimWhiteSpace)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Sets whether whitespace should be trimmed inside of tags.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withXsiTypeMap(java.util.Map)" class="member-name-link">withXsiTypeMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?>> xsiTypeMap)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">When parsing the XML into JSON, specifies that the values with attribute xsi:type
|
||||
will be converted to target type defined to client in this configuration
|
||||
<code>Map<String, XMLXsiTypeConverter<?>></code> to parse values with attribute
|
||||
xsi:type="integer" as integer, xsi:type="string" as string</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.ParserConfiguration">Methods inherited from class org.json.<a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></h3>
|
||||
<code><a href="ParserConfiguration.html#getMaxNestingDepth()">getMaxNestingDepth</a>, <a href="ParserConfiguration.html#isKeepStrings()">isKeepStrings</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="ORIGINAL">
|
||||
<h3>ORIGINAL</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">ORIGINAL</span></div>
|
||||
<div class="block">Original Configuration of the XML Parser.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="KEEP_STRINGS">
|
||||
<h3>KEEP_STRINGS</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">KEEP_STRINGS</span></div>
|
||||
<div class="block">Original configuration of the XML Parser except that values are kept as strings.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>XMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XMLParserConfiguration</span>()</div>
|
||||
<div class="block">Default parser configuration. Does not keep strings (tries to implicitly convert
|
||||
values), and the CDATA Tag Name is "content". Trims whitespace.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(boolean)">
|
||||
<h3>XMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||||
</span><span class="modifiers">public</span> <span class="element-name">XMLParserConfiguration</span><wbr><span class="parameters">(boolean keepStrings)</span></div>
|
||||
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.
|
||||
This constructor may be removed in a future release.</div>
|
||||
</div>
|
||||
<div class="block">Configure the parser string processing and use the default CDATA Tag Name as "content".</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>keepStrings</code> - <code>true</code> to parse all values as string.
|
||||
<code>false</code> to try and convert XML string values into a JSON value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>XMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||||
</span><span class="modifiers">public</span> <span class="element-name">XMLParserConfiguration</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName)</span></div>
|
||||
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.
|
||||
This constructor may be removed in a future release.</div>
|
||||
</div>
|
||||
<div class="block">Configure the parser string processing to try and convert XML values to JSON values and
|
||||
use the passed CDATA Tag Name the processing value. Pass <code>null</code> to
|
||||
disable CDATA processing</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>cDataTagName</code> - <code>null</code> to disable CDATA processing. Any other value
|
||||
to use that value as the JSONObject key name to process as CDATA.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(boolean,java.lang.String)">
|
||||
<h3>XMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||||
</span><span class="modifiers">public</span> <span class="element-name">XMLParserConfiguration</span><wbr><span class="parameters">(boolean keepStrings,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName)</span></div>
|
||||
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.
|
||||
This constructor may be removed in a future release.</div>
|
||||
</div>
|
||||
<div class="block">Configure the parser to use custom settings.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>keepStrings</code> - <code>true</code> to parse all values as string.
|
||||
<code>false</code> to try and convert XML string values into a JSON value.</dd>
|
||||
<dd><code>cDataTagName</code> - <code>null</code> to disable CDATA processing. Any other value
|
||||
to use that value as the JSONObject key name to process as CDATA.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(boolean,java.lang.String,boolean)">
|
||||
<h3>XMLParserConfiguration</h3>
|
||||
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
||||
</span><span class="modifiers">public</span> <span class="element-name">XMLParserConfiguration</span><wbr><span class="parameters">(boolean keepStrings,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> cDataTagName,
|
||||
boolean convertNilAttributeToNull)</span></div>
|
||||
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
||||
<div class="deprecation-comment">This constructor has been deprecated in favor of using the new builder
|
||||
pattern for the configuration.
|
||||
This constructor may be removed or marked private in a future release.</div>
|
||||
</div>
|
||||
<div class="block">Configure the parser to use custom settings.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>keepStrings</code> - <code>true</code> to parse all values as string.
|
||||
<code>false</code> to try and convert XML string values into a JSON value.</dd>
|
||||
<dd><code>cDataTagName</code> - <code>null</code> to disable CDATA processing. Any other value
|
||||
to use that value as the JSONObject key name to process as CDATA.</dd>
|
||||
<dd><code>convertNilAttributeToNull</code> - <code>true</code> to parse values with attribute xsi:nil="true" as null.
|
||||
<code>false</code> to parse values with attribute xsi:nil="true" as {"xsi:nil":true}.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="clone()">
|
||||
<h3>clone</h3>
|
||||
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">clone</span>()</div>
|
||||
<div class="block">Provides a new instance of the same configuration.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#clone()">clone</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withKeepStrings(boolean)">
|
||||
<h3>withKeepStrings</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withKeepStrings</span><wbr><span class="parameters">(boolean newVal)</span></div>
|
||||
<div class="block">When parsing the XML into JSON, specifies if values should be kept as strings (<code>true</code>), or if
|
||||
they should try to be guessed into JSON values (numeric, boolean, string)</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#withKeepStrings(boolean)">withKeepStrings</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>newVal</code> - new value to use for the <code>keepStrings</code> configuration option.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getcDataTagName()">
|
||||
<h3>getcDataTagName</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getcDataTagName</span>()</div>
|
||||
<div class="block">The name of the key in a JSON Object that indicates a CDATA section. Historically this has
|
||||
been the value "content" but can be changed. Use <code>null</code> to indicate no CDATA
|
||||
processing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <code>cDataTagName</code> configuration value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withcDataTagName(java.lang.String)">
|
||||
<h3>withcDataTagName</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withcDataTagName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> newVal)</span></div>
|
||||
<div class="block">The name of the key in a JSON Object that indicates a CDATA section. Historically this has
|
||||
been the value "content" but can be changed. Use <code>null</code> to indicate no CDATA
|
||||
processing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>newVal</code> - new value to use for the <code>cDataTagName</code> configuration option.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="isConvertNilAttributeToNull()">
|
||||
<h3>isConvertNilAttributeToNull</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isConvertNilAttributeToNull</span>()</div>
|
||||
<div class="block">When parsing the XML into JSON, specifies if values with attribute xsi:nil="true"
|
||||
should be kept as attribute(<code>false</code>), or they should be converted to
|
||||
<code>null</code>(<code>true</code>)</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The <code>convertNilAttributeToNull</code> configuration value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withConvertNilAttributeToNull(boolean)">
|
||||
<h3>withConvertNilAttributeToNull</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withConvertNilAttributeToNull</span><wbr><span class="parameters">(boolean newVal)</span></div>
|
||||
<div class="block">When parsing the XML into JSON, specifies if values with attribute xsi:nil="true"
|
||||
should be kept as attribute(<code>false</code>), or they should be converted to
|
||||
<code>null</code>(<code>true</code>)</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>newVal</code> - new value to use for the <code>convertNilAttributeToNull</code> configuration option.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getXsiTypeMap()">
|
||||
<h3>getXsiTypeMap</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?>></span> <span class="element-name">getXsiTypeMap</span>()</div>
|
||||
<div class="block">When parsing the XML into JSON, specifies that the values with attribute xsi:type
|
||||
will be converted to target type defined to client in this configuration
|
||||
<code>Map<String, XMLXsiTypeConverter<?>></code> to parse values with attribute
|
||||
xsi:type="integer" as integer, xsi:type="string" as string</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>xsiTypeMap</code> unmodifiable configuration map.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withXsiTypeMap(java.util.Map)">
|
||||
<h3>withXsiTypeMap</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withXsiTypeMap</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><?>> xsiTypeMap)</span></div>
|
||||
<div class="block">When parsing the XML into JSON, specifies that the values with attribute xsi:type
|
||||
will be converted to target type defined to client in this configuration
|
||||
<code>Map<String, XMLXsiTypeConverter<?>></code> to parse values with attribute
|
||||
xsi:type="integer" as integer, xsi:type="string" as string</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>xsiTypeMap</code> - <code>new HashMap<String, XMLXsiTypeConverter<?>>()</code> to parse values with attribute
|
||||
xsi:type="integer" as integer, xsi:type="string" as string</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getForceList()">
|
||||
<h3>getForceList</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getForceList</span>()</div>
|
||||
<div class="block">When parsing the XML into JSON, specifies that tags that will be converted to arrays
|
||||
in this configuration <code>Set<String></code> to parse the provided tags' values as arrays</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>forceList</code> unmodifiable configuration set.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withForceList(java.util.Set)">
|
||||
<h3>withForceList</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withForceList</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> forceList)</span></div>
|
||||
<div class="block">When parsing the XML into JSON, specifies that tags that will be converted to arrays
|
||||
in this configuration <code>Set<String></code> to parse the provided tags' values as arrays</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>forceList</code> - <code>new HashSet<String>()</code> to parse the provided tags' values as arrays</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withMaxNestingDepth(int)">
|
||||
<h3>withMaxNestingDepth</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withMaxNestingDepth</span><wbr><span class="parameters">(int maxNestingDepth)</span></div>
|
||||
<div class="block">Defines the maximum nesting depth that the parser will descend before throwing an exception
|
||||
when parsing the XML into JSON. The default max nesting depth is 512, which means the parser
|
||||
will throw a JsonException if the maximum depth is reached.
|
||||
Using any negative value as a parameter is equivalent to setting no limit to the nesting depth,
|
||||
which means the parses will go as deep as the maximum call stack size allows.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="ParserConfiguration.html#withMaxNestingDepth(int)">withMaxNestingDepth</a></code> in class <code><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maxNestingDepth</code> - the maximum nesting depth allowed to the XML parser</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The existing configuration will not be modified. A new configuration is returned.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withCloseEmptyTag(boolean)">
|
||||
<h3>withCloseEmptyTag</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withCloseEmptyTag</span><wbr><span class="parameters">(boolean closeEmptyTag)</span></div>
|
||||
<div class="block">To enable explicit end tag with empty value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>closeEmptyTag</code> - new value for the closeEmptyTag property</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>same instance of configuration with empty tag config updated</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="withShouldTrimWhitespace(boolean)">
|
||||
<h3>withShouldTrimWhitespace</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></span> <span class="element-name">withShouldTrimWhitespace</span><wbr><span class="parameters">(boolean shouldTrimWhiteSpace)</span></div>
|
||||
<div class="block">Sets whether whitespace should be trimmed inside of tags. *NOTE* Do not use this if
|
||||
you expect your XML tags to have names that are the same as cDataTagName as this is unsupported.
|
||||
cDataTagName should be set to a distinct value in these cases.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>shouldTrimWhiteSpace</code> - boolean to set trimming on or off. Off is default.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>same instance of configuration with empty tag config updated</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="isCloseEmptyTag()">
|
||||
<h3>isCloseEmptyTag</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCloseEmptyTag</span>()</div>
|
||||
<div class="block">Checks if the parser should automatically close empty XML tags.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>true</code> if empty XML tags should be automatically closed, <code>false</code> otherwise.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="shouldTrimWhiteSpace()">
|
||||
<h3>shouldTrimWhiteSpace</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">shouldTrimWhiteSpace</span>()</div>
|
||||
<div class="block">Checks if the parser should trim white spaces from XML content.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>true</code> if white spaces should be trimmed, <code>false</code> otherwise.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,373 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>XMLTokener</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, class: XMLTokener">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<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="sub-nav-list">
|
||||
<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>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Class XMLTokener" class="title">Class XMLTokener</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="JSONTokener.html" title="class in org.json">org.json.JSONTokener</a>
|
||||
<div class="inheritance">org.json.XMLTokener</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">XMLTokener</span>
|
||||
<span class="extends-implements">extends <a href="JSONTokener.html" title="class in org.json">JSONTokener</a></span></div>
|
||||
<div class="block">The XMLTokener extends the JSONTokener to provide additional methods
|
||||
for the parsing of XML texts.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#entity" class="member-name-link">entity</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The table of entity values.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.Reader)" class="member-name-link">XMLTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> r)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct an XMLTokener from a Reader.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.io.Reader,org.json.XMLParserConfiguration)" class="member-name-link">XMLTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> r,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> configuration)</code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Construct an XMLTokener from a Reader and an XMLParserConfiguration.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">XMLTokener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct an XMLTokener from a string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextCDATA()" class="member-name-link">nextCDATA</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the text in the CDATA block.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextContent()" class="member-name-link">nextContent</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the next XML outer token, trimming whitespace.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextEntity(char)" class="member-name-link">nextEntity</a><wbr>(char ampersand)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block"><code>
|
||||
Return the next entity. These entities are translated to Characters:
|
||||
&amp; &apos; &gt; &lt; &quot;.
|
||||
</code></div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextMeta()" class="member-name-link">nextMeta</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block"><code>
|
||||
Returns the next XML meta token. This is used for skipping over <!...>
|
||||
and <?...?> structures.
|
||||
</code></div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#nextToken()" class="member-name-link">nextToken</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block"><code>
|
||||
Get the next XML Token. These tokens are found inside of angle
|
||||
brackets. It may be one of these characters: / > = ! ? or it
|
||||
may be a string wrapped in single quotes or double quotes, or it may be a
|
||||
name.
|
||||
</code></div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#skipPast(java.lang.String)" class="member-name-link">skipPast</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Skip characters until past the requested string.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-org.json.JSONTokener">Methods inherited from class org.json.<a href="JSONTokener.html" title="class in org.json">JSONTokener</a></h3>
|
||||
<code><a href="JSONTokener.html#back()">back</a>, <a href="JSONTokener.html#close()">close</a>, <a href="JSONTokener.html#dehexchar(char)">dehexchar</a>, <a href="JSONTokener.html#end()">end</a>, <a href="JSONTokener.html#getPrevious()">getPrevious</a>, <a href="JSONTokener.html#more()">more</a>, <a href="JSONTokener.html#next()">next</a>, <a href="JSONTokener.html#next(char)">next</a>, <a href="JSONTokener.html#next(int)">next</a>, <a href="JSONTokener.html#nextClean()">nextClean</a>, <a href="JSONTokener.html#nextString(char)">nextString</a>, <a href="JSONTokener.html#nextTo(char)">nextTo</a>, <a href="JSONTokener.html#nextTo(java.lang.String)">nextTo</a>, <a href="JSONTokener.html#nextValue()">nextValue</a>, <a href="JSONTokener.html#skipTo(char)">skipTo</a>, <a href="JSONTokener.html#syntaxError(java.lang.String)">syntaxError</a>, <a href="JSONTokener.html#syntaxError(java.lang.String,java.lang.Throwable)">syntaxError</a>, <a href="JSONTokener.html#toString()">toString</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="entity">
|
||||
<h3>entity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Character.html" title="class or interface in java.lang" class="external-link">Character</a>></span> <span class="element-name">entity</span></div>
|
||||
<div class="block">The table of entity values. It initially contains Character values for
|
||||
amp, apos, gt, lt, quot.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.io.Reader)">
|
||||
<h3>XMLTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XMLTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> r)</span></div>
|
||||
<div class="block">Construct an XMLTokener from a Reader.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>r</code> - A source reader.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.lang.String)">
|
||||
<h3>XMLTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XMLTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div>
|
||||
<div class="block">Construct an XMLTokener from a string.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>s</code> - A source string.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.io.Reader,org.json.XMLParserConfiguration)">
|
||||
<h3>XMLTokener</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XMLTokener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link">Reader</a> r,
|
||||
<a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a> configuration)</span></div>
|
||||
<div class="block">Construct an XMLTokener from a Reader and an XMLParserConfiguration.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>r</code> - A source reader.</dd>
|
||||
<dd><code>configuration</code> - the configuration that can be used to set certain flags</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="nextCDATA()">
|
||||
<h3>nextCDATA</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">nextCDATA</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the text in the CDATA block.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The string up to the <code>]]></code>.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the <code>]]></code> is not found.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextContent()">
|
||||
<h3>nextContent</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">nextContent</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block">Get the next XML outer token, trimming whitespace. There are two kinds
|
||||
of tokens: the <pre><code>'<' </code></pre> character which begins a markup
|
||||
tag, and the content
|
||||
text between markup tags.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A string, or a <pre><code>'<' </code></pre> Character, or null if
|
||||
there is no more source text.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextEntity(char)">
|
||||
<h3>nextEntity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">nextEntity</span><wbr><span class="parameters">(char ampersand)</span>
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block"><pre><code>
|
||||
Return the next entity. These entities are translated to Characters:
|
||||
&amp; &apos; &gt; &lt; &quot;.
|
||||
</code></pre></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>ampersand</code> - An ampersand character.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A Character or an entity String if the entity is not recognized.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If missing ';' in XML entity.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextMeta()">
|
||||
<h3>nextMeta</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">nextMeta</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block"><pre><code>
|
||||
Returns the next XML meta token. This is used for skipping over <!...>
|
||||
and <?...?> structures.
|
||||
</code></pre></div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><pre><code>Syntax characters (< > / = ! ?) are returned as
|
||||
Character, and strings and names are returned as Boolean. We don't care
|
||||
what the values actually are.
|
||||
</code></pre></dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If a string is not properly closed or if the XML
|
||||
is badly structured.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nextToken()">
|
||||
<h3>nextToken</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">nextToken</span>()
|
||||
throws <span class="exceptions"><a href="JSONException.html" title="class in org.json">JSONException</a></span></div>
|
||||
<div class="block"><pre><code>
|
||||
Get the next XML Token. These tokens are found inside of angle
|
||||
brackets. It may be one of these characters: / > = ! ? or it
|
||||
may be a string wrapped in single quotes or double quotes, or it may be a
|
||||
name.
|
||||
</code></pre></div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>a String or a Character.</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="JSONException.html" title="class in org.json">JSONException</a></code> - If the XML is not well formed.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="skipPast(java.lang.String)">
|
||||
<h3>skipPast</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">skipPast</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</span></div>
|
||||
<div class="block">Skip characters until past the requested string.
|
||||
If it is not found, we are left at the end of the source with a result of false.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>to</code> - A string to skip past.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,171 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>XMLXsiTypeConverter</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json, interface: XMLXsiTypeConverter">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">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#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li>Constr | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.json</a></div>
|
||||
<h1 title="Interface XMLXsiTypeConverter" class="title">Interface XMLXsiTypeConverter<T></h1>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>Type Parameters:</dt>
|
||||
<dd><code>T</code> - return type of convert method</dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">XMLXsiTypeConverter<T></span></div>
|
||||
<div class="block">Type conversion configuration interface to be used with xsi:type attributes.
|
||||
<pre>
|
||||
<b>XML Sample</b>
|
||||
<code>
|
||||
<root>
|
||||
<asString xsi:type="string">12345</asString>
|
||||
<asInt xsi:type="integer">54321</asInt>
|
||||
</root>
|
||||
</code>
|
||||
<b>JSON Output</b>
|
||||
<code>
|
||||
{
|
||||
"root" : {
|
||||
"asString" : "12345",
|
||||
"asInt": 54321
|
||||
}
|
||||
}
|
||||
</code>
|
||||
|
||||
<b>Usage</b>
|
||||
<code>
|
||||
Map<String, XMLXsiTypeConverter<?>> xsiTypeMap = new HashMap<String, XMLXsiTypeConverter<?>>();
|
||||
xsiTypeMap.put("string", new XMLXsiTypeConverter<String>() {
|
||||
&#64;Override public String convert(final String value) {
|
||||
return value;
|
||||
}
|
||||
});
|
||||
xsiTypeMap.put("integer", new XMLXsiTypeConverter<Integer>() {
|
||||
&#64;Override public Integer convert(final String value) {
|
||||
return Integer.valueOf(value);
|
||||
}
|
||||
});
|
||||
</code>
|
||||
</pre></div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="XMLXsiTypeConverter.html" title="type parameter in XMLXsiTypeConverter">T</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#convert(java.lang.String)" class="member-name-link">convert</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<div class="block">Converts an XML xsi:type attribute value to the specified type <code>T</code>.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="convert(java.lang.String)">
|
||||
<h3>convert</h3>
|
||||
<div class="member-signature"><span class="return-type"><a href="XMLXsiTypeConverter.html" title="type parameter in XMLXsiTypeConverter">T</a></span> <span class="element-name">convert</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div>
|
||||
<div class="block">Converts an XML xsi:type attribute value to the specified type <code>T</code>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>value</code> - The string representation of the XML xsi:type attribute value to be converted.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An object of type <code>T</code> representing the converted value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,205 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>org.json</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="declaration: package: org.json">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>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#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li>Related Packages | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="Package org.json" class="title">Package org.json</h1>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">org.json</span></div>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button><button id="class-summary-tab7" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab7', 2)" class="table-tab">Annotation Interfaces</button></div>
|
||||
<div id="class-summary.tabpanel" role="tabpanel">
|
||||
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CDL.html" title="class in org.json">CDL</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">This provides static methods to convert comma (or otherwise) delimited text into a
|
||||
JSONArray, and to convert a JSONArray into comma (or otherwise) delimited text.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Cookie.html" title="class in org.json">Cookie</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Convert a web browser cookie specification to a JSONObject and back.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CookieList.html" title="class in org.json">CookieList</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Convert a web browser cookie list string to a JSONObject and back.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HTTP.html" title="class in org.json">HTTP</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Convert an HTTP header to a JSONObject and back.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HTTPTokener.html" title="class in org.json">HTTPTokener</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">The HTTPTokener extends the JSONTokener to provide additional methods
|
||||
for the parsing of HTTP headers.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONArray.html" title="class in org.json">JSONArray</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A JSONArray is an ordered sequence of values.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="JSONException.html" title="class in org.json">JSONException</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab5">
|
||||
<div class="block">The JSONException is thrown by the JSON.org classes when things are amiss.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONML.html" title="class in org.json">JSONML</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JSONMLParserConfiguration.html" title="class in org.json">JSONMLParserConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Configuration object for the XML to JSONML parser.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONObject.html" title="class in org.json">JSONObject</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A JSONObject is an unordered collection of name/value pairs.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JSONParserConfiguration.html" title="class in org.json">JSONParserConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Configuration object for the JSON parser.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONPointer.html" title="class in org.json">JSONPointer</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A JSON Pointer is a simple query language defined for JSON documents by
|
||||
<a href="https://tools.ietf.org/html/rfc6901">RFC 6901</a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JSONPointer.Builder.html" title="class in org.json">JSONPointer.Builder</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">This class allows the user to build a JSONPointer in steps, using
|
||||
exactly one segment in each step.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="JSONPointerException.html" title="class in org.json">JSONPointerException</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab5">
|
||||
<div class="block">The JSONPointerException is thrown by <a href="JSONPointer.html" title="class in org.json"><code>JSONPointer</code></a> if an error occurs
|
||||
during evaluating a pointer.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab7"><a href="JSONPropertyIgnore.html" title="annotation interface in org.json">JSONPropertyIgnore</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab7">
|
||||
<div class="block">Use this annotation on a getter method to override the Bean name
|
||||
parser for Bean -> JSONObject mapping.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab7"><a href="JSONPropertyName.html" title="annotation interface in org.json">JSONPropertyName</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab7">
|
||||
<div class="block">Use this annotation on a getter method to override the Bean name
|
||||
parser for Bean -> JSONObject mapping.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="JSONString.html" title="interface in org.json">JSONString</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab1">
|
||||
<div class="block">The <code>JSONString</code> interface allows a <code>toJSONString()</code>
|
||||
method so that a class can change the behavior of
|
||||
<code>JSONObject.toString()</code>, <code>JSONArray.toString()</code>,
|
||||
and <code>JSONWriter.value(</code>Object<code>)</code>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONStringer.html" title="class in org.json">JSONStringer</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">JSONStringer provides a quick and convenient way of producing JSON text.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="JSONTokener.html" title="class in org.json">JSONTokener</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">A JSONTokener takes a source string and extracts characters and tokens from
|
||||
it.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JSONWriter.html" title="class in org.json">JSONWriter</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">JSONWriter provides a quick and convenient way of producing JSON text.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ParserConfiguration.html" title="class in org.json">ParserConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Configuration base object for parsers.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Property.html" title="class in org.json">Property</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Converts a Property file data into JSONObject and back.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="XML.html" title="class in org.json">XML</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">This provides static methods to convert an XML text into a JSONObject, and to
|
||||
covert a JSONObject into an XML text.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="XMLParserConfiguration.html" title="class in org.json">XMLParserConfiguration</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Configuration object for the XML parser.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="XMLTokener.html" title="class in org.json">XMLTokener</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">The XMLTokener extends the JSONTokener to provide additional methods
|
||||
for the parsing of XML texts.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="XMLXsiTypeConverter.html" title="interface in org.json">XMLXsiTypeConverter</a><T></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab1">
|
||||
<div class="block">Type conversion configuration interface to be used with xsi:type attributes.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,126 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Sat Mar 02 18:43:47 CST 2024 -->
|
||||
<title>org.json Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
<meta name="dc.created" content="2024-03-02">
|
||||
<meta name="description" content="tree: package: org.json">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</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#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">Hierarchy For Package org.json</h1>
|
||||
</div>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="CDL.html" class="type-name-link" title="class in org.json">CDL</a></li>
|
||||
<li class="circle">org.json.<a href="Cookie.html" class="type-name-link" title="class in org.json">Cookie</a></li>
|
||||
<li class="circle">org.json.<a href="CookieList.html" class="type-name-link" title="class in org.json">CookieList</a></li>
|
||||
<li class="circle">org.json.<a href="HTTP.html" class="type-name-link" title="class in org.json">HTTP</a></li>
|
||||
<li class="circle">org.json.<a href="JSONArray.html" class="type-name-link" title="class in org.json">JSONArray</a> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><T>)</li>
|
||||
<li class="circle">org.json.<a href="JSONML.html" class="type-name-link" title="class in org.json">JSONML</a></li>
|
||||
<li class="circle">org.json.<a href="JSONObject.html" class="type-name-link" title="class in org.json">JSONObject</a></li>
|
||||
<li class="circle">org.json.<a href="JSONPointer.html" class="type-name-link" title="class in org.json">JSONPointer</a></li>
|
||||
<li class="circle">org.json.<a href="JSONPointer.Builder.html" class="type-name-link" title="class in org.json">JSONPointer.Builder</a></li>
|
||||
<li class="circle">org.json.<a href="JSONTokener.html" class="type-name-link" title="class in org.json">JSONTokener</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="HTTPTokener.html" class="type-name-link" title="class in org.json">HTTPTokener</a></li>
|
||||
<li class="circle">org.json.<a href="XMLTokener.html" class="type-name-link" title="class in org.json">XMLTokener</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.json.<a href="JSONWriter.html" class="type-name-link" title="class in org.json">JSONWriter</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONStringer.html" class="type-name-link" title="class in org.json">JSONStringer</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.json.<a href="ParserConfiguration.html" class="type-name-link" title="class in org.json">ParserConfiguration</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONMLParserConfiguration.html" class="type-name-link" title="class in org.json">JSONMLParserConfiguration</a></li>
|
||||
<li class="circle">org.json.<a href="JSONParserConfiguration.html" class="type-name-link" title="class in org.json">JSONParserConfiguration</a></li>
|
||||
<li class="circle">org.json.<a href="XMLParserConfiguration.html" class="type-name-link" title="class in org.json">XMLParserConfiguration</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.json.<a href="Property.html" class="type-name-link" title="class in org.json">Property</a></li>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" class="type-name-link external-link" title="class or interface in java.lang">Throwable</a> (implements java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" class="type-name-link external-link" title="class or interface in java.lang">Exception</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html" class="type-name-link external-link" title="class or interface in java.lang">RuntimeException</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONException.html" class="type-name-link" title="class in org.json">JSONException</a>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONPointerException.html" class="type-name-link" title="class in org.json">JSONPointerException</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">org.json.<a href="XML.html" class="type-name-link" title="class in org.json">XML</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONString.html" class="type-name-link" title="interface in org.json">JSONString</a></li>
|
||||
<li class="circle">org.json.<a href="XMLXsiTypeConverter.html" class="type-name-link" title="interface in org.json">XMLXsiTypeConverter</a><T></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Annotation Interface Hierarchy">Annotation Interface Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">org.json.<a href="JSONPropertyIgnore.html" class="type-name-link" title="annotation interface in org.json">JSONPropertyIgnore</a> (implements java.lang.annotation.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>)</li>
|
||||
<li class="circle">org.json.<a href="JSONPropertyName.html" class="type-name-link" title="annotation interface in org.json">JSONPropertyName</a> (implements java.lang.annotation.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/annotation/Annotation.html" title="class or interface in java.lang.annotation" class="external-link">Annotation</a>)</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user