| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonCollectors</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonCollectors"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../jakarta/json/stream/JsonGenerationException.html" title="class in jakarta.json.stream"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/json/stream/JsonCollectors.html" target="_top">Frames</a></li> |
| <li><a href="JsonCollectors.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.json.stream</div> |
| <h2 title="Class JsonCollectors" class="title">Class JsonCollectors</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.json.stream.JsonCollectors</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">JsonCollectors</span> |
| extends java.lang.Object</pre> |
| <div class="block">This class contains some implementations of <code>java.util.stream.Collector</code> for accumulating |
| <a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json"><code>JsonValue</code></a>s into <a href="../../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>JsonArray</code></a> and <a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.util.Map<java.lang.String,<a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/json/stream/JsonCollectors.html#groupingBy-java.util.function.Function-">groupingBy</a></span>(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> classifier)</code> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that implements a "group by" operation on the |
| input <code>JsonValue</code> elements.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T extends <a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>><br>java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.util.Map<java.lang.String,T>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/json/stream/JsonCollectors.html#groupingBy-java.util.function.Function-java.util.stream.Collector-">groupingBy</a></span>(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> classifier, |
| java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,T,<a href="../../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a>> downstream)</code> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that implements a "group by" operation on the |
| input <code>JsonValue</code> elements.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>,<a href="../../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/json/stream/JsonCollectors.html#toJsonArray--">toJsonArray</a></span>()</code> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>JsonValue</code> |
| elements into a <code>JsonArray</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static java.util.stream.Collector<java.util.Map.Entry<java.lang.String,<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>>,<a href="../../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/json/stream/JsonCollectors.html#toJsonObject--">toJsonObject</a></span>()</code> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>Map.Entry<String,JsonValue></code> |
| elements into a <code>JsonObject</code>.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/json/stream/JsonCollectors.html#toJsonObject-java.util.function.Function-java.util.function.Function-">toJsonObject</a></span>(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> keyMapper, |
| java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>> valueMapper)</code> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>JsonValue</code> |
| elements into a <code>JsonObject</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="toJsonArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJsonArray</h4> |
| <pre>public static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>,<a href="../../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a>> toJsonArray()</pre> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>JsonValue</code> |
| elements into a <code>JsonArray</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constructed Collector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJsonObject--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJsonObject</h4> |
| <pre>public static java.util.stream.Collector<java.util.Map.Entry<java.lang.String,<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>>,<a href="../../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>> toJsonObject()</pre> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>Map.Entry<String,JsonValue></code> |
| elements into a <code>JsonObject</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constructed Collector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJsonObject-java.util.function.Function-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toJsonObject</h4> |
| <pre>public static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>> toJsonObject(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> keyMapper, |
| java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>> valueMapper)</pre> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that accumulates the input <code>JsonValue</code> |
| elements into a <code>JsonObject</code>. The name/value pairs of the <code>JsonObject</code> are computed |
| by applying the provided mapping functions.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyMapper</code> - a mapping function to produce names.</dd> |
| <dd><code>valueMapper</code> - a mapping function to produce values</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constructed Collector</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="groupingBy-java.util.function.Function-java.util.stream.Collector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>groupingBy</h4> |
| <pre>public static <T extends <a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>> java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.util.Map<java.lang.String,T>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>> groupingBy(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> classifier, |
| java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,T,<a href="../../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a>> downstream)</pre> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that implements a "group by" operation on the |
| input <code>JsonValue</code> elements. A classifier function maps the input <code>JsonValue</code>s to keys, and |
| the <code>JsonValue</code>s are partitioned into groups according to the value of the key. |
| A reduction operation is performed on the <code>JsonValue</code>s in each group, using the |
| downstream <code>Collector</code>. For each group, the key and the results of the reduction operation |
| become the name/value pairs of the resultant <code>JsonObject</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the intermediate accumulation <code>JsonArrayBuilder</code> of the downstream collector</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classifier</code> - a function mapping the input <code>JsonValue</code>s to a String, producing keys</dd> |
| <dd><code>downstream</code> - a <code>Collector</code> that implements a reduction operation on the |
| <code>JsonValue</code>s in each group.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constructed <code>Collector</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="groupingBy-java.util.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>groupingBy</h4> |
| <pre>public static java.util.stream.Collector<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.util.Map<java.lang.String,<a href="../../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>>,<a href="../../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a>> groupingBy(java.util.function.Function<<a href="../../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a>,java.lang.String> classifier)</pre> |
| <div class="block">Constructs a <code>java.util.stream.Collector</code> that implements a "group by" operation on the |
| input <code>JsonValue</code> elements. A classifier function maps the input <code>JsonValue</code>s to keys, and |
| the <code>JsonValue</code>s are partitioned into groups according to the value of the key. |
| The <code>JsonValue</code>s in each group are added to a <code>JsonArray</code>. The key and the |
| <code>JsonArray</code> in each group becomes the name/value pair of the resultant <code>JsonObject</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>classifier</code> - a function mapping the input <code>JsonValue</code>s to a String, producing keys</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the constructed <code>Collector</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../jakarta/json/stream/JsonGenerationException.html" title="class in jakarta.json.stream"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/json/stream/JsonCollectors.html" target="_top">Frames</a></li> |
| <li><a href="JsonCollectors.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |