blob: 77aeafaaf96d9bc7db18cdb738ee628357f44b1c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface jakarta.json.JsonStructure (JSON Processing API documentation)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Interface jakarta.json.JsonStructure (JSON Processing API documentation)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="../../../module-summary.html">Module</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../JsonStructure.html" title="interface in jakarta.json">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><br>JSON Processing API v2.0.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface jakarta.json.JsonStructure" class="title">Uses of Interface<br>jakarta.json.JsonStructure</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#jakarta.json">jakarta.json</a></th>
<td class="colLast">
<div class="block">Provides an object model API to process <a href="http://json.org/">JSON</a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#jakarta.json.spi">jakarta.json.spi</a></th>
<td class="colLast">
<div class="block">Service Provider Interface (SPI) to plug in implementations for
JSON processing objects.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="jakarta.json">
<!-- -->
</a>
<h3>Uses of <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a> in <a href="../package-summary.html">jakarta.json</a></h3>
<table class="useSummary">
<caption><span>Subinterfaces of <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a> in <a href="../package-summary.html">jakarta.json</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../JsonArray.html" title="interface in jakarta.json">JsonArray</a></span></code></th>
<td class="colLast">
<div class="block"><code>JsonArray</code> represents an immutable JSON array
(an ordered sequence of zero or more values).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../JsonObject.html" title="interface in jakarta.json">JsonObject</a></span></code></th>
<td class="colLast">
<div class="block"><code>JsonObject</code> class represents an immutable JSON object value
(an unordered collection of zero or more name/value pairs).</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">jakarta.json</a> with type parameters of type <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPointer.</span><code><span class="memberNameLink"><a href="../JsonPointer.html#add(T,jakarta.json.JsonValue)">add</a></span>&#8203;(T&nbsp;target,
<a href="../JsonValue.html" title="interface in jakarta.json">JsonValue</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds or replaces a value at the referenced location in the specified
<code>target</code> with the specified <code>value</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPatch.</span><code><span class="memberNameLink"><a href="../JsonPatch.html#apply(T)">apply</a></span>&#8203;(T&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Applies the patch operations to the specified <code>target</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;T extends <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPointer.</span><code><span class="memberNameLink"><a href="../JsonPointer.html#remove(T)">remove</a></span>&#8203;(T&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Removes the value at the reference location in the specified <code>target</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&gt;<br>T</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPointer.</span><code><span class="memberNameLink"><a href="../JsonPointer.html#replace(T,jakarta.json.JsonValue)">replace</a></span>&#8203;(T&nbsp;target,
<a href="../JsonValue.html" title="interface in jakarta.json">JsonValue</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Replaces the value at the referenced location in the specified
<code>target</code> with the specified <code>value</code>.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">jakarta.json</a> that return <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonReader.</span><code><span class="memberNameLink"><a href="../JsonReader.html#read()">read</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a JSON array or object that is represented in
the input source.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">jakarta.json</a> with parameters of type <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPointer.</span><code><span class="memberNameLink"><a href="../JsonPointer.html#containsValue(jakarta.json.JsonStructure)">containsValue</a></span>&#8203;(<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if there is a value at the referenced location in the specified <code>target</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../JsonPatch.html" title="interface in jakarta.json">JsonPatch</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Json.</span><code><span class="memberNameLink"><a href="../Json.html#createDiff(jakarta.json.JsonStructure,jakarta.json.JsonStructure)">createDiff</a></span>&#8203;(<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;source,
<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Generates a JSON Patch (<a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>)
from the source and target <code>JsonStructure</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../JsonValue.html" title="interface in jakarta.json">JsonValue</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonPointer.</span><code><span class="memberNameLink"><a href="../JsonPointer.html#getValue(jakarta.json.JsonStructure)">getValue</a></span>&#8203;(<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Returns the value at the referenced location in the specified <code>target</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonWriter.</span><code><span class="memberNameLink"><a href="../JsonWriter.html#write(jakarta.json.JsonStructure)">write</a></span>&#8203;(<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Writes the specified JSON <a href="../JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or
<a href="../JsonArray.html" title="interface in jakarta.json"><code>array</code></a> to the output source.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="jakarta.json.spi">
<!-- -->
</a>
<h3>Uses of <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a> in <a href="../spi/package-summary.html">jakarta.json.spi</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../spi/package-summary.html">jakarta.json.spi</a> with parameters of type <a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../JsonPatch.html" title="interface in jakarta.json">JsonPatch</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">JsonProvider.</span><code><span class="memberNameLink"><a href="../spi/JsonProvider.html#createDiff(jakarta.json.JsonStructure,jakarta.json.JsonStructure)">createDiff</a></span>&#8203;(<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;source,
<a href="../JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>&nbsp;target)</code></th>
<td class="colLast">
<div class="block">Generates a JSON Patch (<a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>)
from the source and target <code>JsonStructure</code>.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="../../../module-summary.html">Module</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../JsonStructure.html" title="interface in jakarta.json">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><br>JSON Processing API v2.0.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Comments to: <a href="mailto:jsonp-dev@eclipse.org">jsonp-dev@eclipse.org</a>.<br> Copyright &#169; 2019, 2020 Eclipse Foundation. All rights reserved.<br> Use is subject to <a href="../../../../doc-files/speclicense.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>