| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|---|
| 2 | <!-- NewPage -->
|
|---|
| 3 | <html lang="en">
|
|---|
| 4 | <head>
|
|---|
| 5 | <!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:58 CEST 2018 -->
|
|---|
| 6 | <title>XmlWriteStream (Genius Core Documentation)</title>
|
|---|
| 7 | <meta name="date" content="2018-06-21">
|
|---|
| 8 | <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|---|
| 9 | <script type="text/javascript" src="../../../script.js"></script>
|
|---|
| 10 | </head>
|
|---|
| 11 | <body>
|
|---|
| 12 | <script type="text/javascript"><!--
|
|---|
| 13 | try {
|
|---|
| 14 | if (location.href.indexOf('is-external=true') == -1) {
|
|---|
| 15 | parent.document.title="XmlWriteStream (Genius Core Documentation)";
|
|---|
| 16 | }
|
|---|
| 17 | }
|
|---|
| 18 | catch(err) {
|
|---|
| 19 | }
|
|---|
| 20 | //-->
|
|---|
| 21 | var methods = {"i0":10,"i1":10,"i2":10};
|
|---|
| 22 | var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|---|
| 23 | var altColor = "altColor";
|
|---|
| 24 | var rowColor = "rowColor";
|
|---|
| 25 | var tableTab = "tableTab";
|
|---|
| 26 | var activeTableTab = "activeTableTab";
|
|---|
| 27 | </script>
|
|---|
| 28 | <noscript>
|
|---|
| 29 | <div>JavaScript is disabled on your browser.</div>
|
|---|
| 30 | </noscript>
|
|---|
| 31 | <!-- ========= START OF TOP NAVBAR ======= -->
|
|---|
| 32 | <div class="topNav"><a name="navbar.top">
|
|---|
| 33 | <!-- -->
|
|---|
| 34 | </a>
|
|---|
| 35 | <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|---|
| 36 | <a name="navbar.top.firstrow">
|
|---|
| 37 | <!-- -->
|
|---|
| 38 | </a>
|
|---|
| 39 | <ul class="navList" title="Navigation">
|
|---|
| 40 | <li><a href="../../../overview-summary.html">Overview</a></li>
|
|---|
| 41 | <li><a href="package-summary.html">Package</a></li>
|
|---|
| 42 | <li class="navBarCell1Rev">Class</li>
|
|---|
| 43 | <li><a href="class-use/XmlWriteStream.html">Use</a></li>
|
|---|
| 44 | <li><a href="package-tree.html">Tree</a></li>
|
|---|
| 45 | <li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|---|
| 46 | <li><a href="../../../index-all.html">Index</a></li>
|
|---|
| 47 | <li><a href="../../../help-doc.html">Help</a></li>
|
|---|
| 48 | </ul>
|
|---|
| 49 | </div>
|
|---|
| 50 | <div class="subNav">
|
|---|
| 51 | <ul class="navList">
|
|---|
| 52 | <li><a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml"><span class="typeNameLink">Prev Class</span></a></li>
|
|---|
| 53 | <li>Next Class</li>
|
|---|
| 54 | </ul>
|
|---|
| 55 | <ul class="navList">
|
|---|
| 56 | <li><a href="../../../index.html?genius/core/xml/XmlWriteStream.html" target="_top">Frames</a></li>
|
|---|
| 57 | <li><a href="XmlWriteStream.html" target="_top">No Frames</a></li>
|
|---|
| 58 | </ul>
|
|---|
| 59 | <ul class="navList" id="allclasses_navbar_top">
|
|---|
| 60 | <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|---|
| 61 | </ul>
|
|---|
| 62 | <div>
|
|---|
| 63 | <script type="text/javascript"><!--
|
|---|
| 64 | allClassesLink = document.getElementById("allclasses_navbar_top");
|
|---|
| 65 | if(window==top) {
|
|---|
| 66 | allClassesLink.style.display = "block";
|
|---|
| 67 | }
|
|---|
| 68 | else {
|
|---|
| 69 | allClassesLink.style.display = "none";
|
|---|
| 70 | }
|
|---|
| 71 | //-->
|
|---|
| 72 | </script>
|
|---|
| 73 | </div>
|
|---|
| 74 | <div>
|
|---|
| 75 | <ul class="subNavList">
|
|---|
| 76 | <li>Summary: </li>
|
|---|
| 77 | <li>Nested | </li>
|
|---|
| 78 | <li>Field | </li>
|
|---|
| 79 | <li><a href="#constructor.summary">Constr</a> | </li>
|
|---|
| 80 | <li><a href="#method.summary">Method</a></li>
|
|---|
| 81 | </ul>
|
|---|
| 82 | <ul class="subNavList">
|
|---|
| 83 | <li>Detail: </li>
|
|---|
| 84 | <li>Field | </li>
|
|---|
| 85 | <li><a href="#constructor.detail">Constr</a> | </li>
|
|---|
| 86 | <li><a href="#method.detail">Method</a></li>
|
|---|
| 87 | </ul>
|
|---|
| 88 | </div>
|
|---|
| 89 | <a name="skip.navbar.top">
|
|---|
| 90 | <!-- -->
|
|---|
| 91 | </a></div>
|
|---|
| 92 | <!-- ========= END OF TOP NAVBAR ========= -->
|
|---|
| 93 | <!-- ======== START OF CLASS DATA ======== -->
|
|---|
| 94 | <div class="header">
|
|---|
| 95 | <div class="subTitle">genius.core.xml</div>
|
|---|
| 96 | <h2 title="Class XmlWriteStream" class="title">Class XmlWriteStream</h2>
|
|---|
| 97 | </div>
|
|---|
| 98 | <div class="contentContainer">
|
|---|
| 99 | <ul class="inheritance">
|
|---|
| 100 | <li>java.lang.Object</li>
|
|---|
| 101 | <li>
|
|---|
| 102 | <ul class="inheritance">
|
|---|
| 103 | <li>genius.core.xml.XmlWriteStream</li>
|
|---|
| 104 | </ul>
|
|---|
| 105 | </li>
|
|---|
| 106 | </ul>
|
|---|
| 107 | <div class="description">
|
|---|
| 108 | <ul class="blockList">
|
|---|
| 109 | <li class="blockList">
|
|---|
| 110 | <hr>
|
|---|
| 111 | <br>
|
|---|
| 112 | <pre>public class <span class="typeNameLabel">XmlWriteStream</span>
|
|---|
| 113 | extends java.lang.Object</pre>
|
|---|
| 114 | <div class="block">a xml stream that can write <code>Map</code>s</div>
|
|---|
| 115 | </li>
|
|---|
| 116 | </ul>
|
|---|
| 117 | </div>
|
|---|
| 118 | <div class="summary">
|
|---|
| 119 | <ul class="blockList">
|
|---|
| 120 | <li class="blockList">
|
|---|
| 121 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|---|
| 122 | <ul class="blockList">
|
|---|
| 123 | <li class="blockList"><a name="constructor.summary">
|
|---|
| 124 | <!-- -->
|
|---|
| 125 | </a>
|
|---|
| 126 | <h3>Constructor Summary</h3>
|
|---|
| 127 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|---|
| 128 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|---|
| 129 | <tr>
|
|---|
| 130 | <th class="colOne" scope="col">Constructor and Description</th>
|
|---|
| 131 | </tr>
|
|---|
| 132 | <tr class="altColor">
|
|---|
| 133 | <td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/xml/XmlWriteStream.html#XmlWriteStream-java.io.OutputStream-java.lang.String-">XmlWriteStream</a></span>(java.io.OutputStream out,
|
|---|
| 134 | java.lang.String topLabel)</code> </td>
|
|---|
| 135 | </tr>
|
|---|
| 136 | </table>
|
|---|
| 137 | </li>
|
|---|
| 138 | </ul>
|
|---|
| 139 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 140 | <ul class="blockList">
|
|---|
| 141 | <li class="blockList"><a name="method.summary">
|
|---|
| 142 | <!-- -->
|
|---|
| 143 | </a>
|
|---|
| 144 | <h3>Method Summary</h3>
|
|---|
| 145 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|---|
| 146 | <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|---|
| 147 | <tr>
|
|---|
| 148 | <th class="colFirst" scope="col">Modifier and Type</th>
|
|---|
| 149 | <th class="colLast" scope="col">Method and Description</th>
|
|---|
| 150 | </tr>
|
|---|
| 151 | <tr id="i0" class="altColor">
|
|---|
| 152 | <td class="colFirst"><code>void</code></td>
|
|---|
| 153 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/xml/XmlWriteStream.html#close--">close</a></span>()</code>
|
|---|
| 154 | <div class="block">Close the stream.</div>
|
|---|
| 155 | </td>
|
|---|
| 156 | </tr>
|
|---|
| 157 | <tr id="i1" class="rowColor">
|
|---|
| 158 | <td class="colFirst"><code>void</code></td>
|
|---|
| 159 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/xml/XmlWriteStream.html#flush--">flush</a></span>()</code> </td>
|
|---|
| 160 | </tr>
|
|---|
| 161 | <tr id="i2" class="altColor">
|
|---|
| 162 | <td class="colFirst"><code>void</code></td>
|
|---|
| 163 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/xml/XmlWriteStream.html#write-java.lang.String-java.util.Map-">write</a></span>(java.lang.String name,
|
|---|
| 164 | java.util.Map<java.lang.Object,java.lang.Object> data)</code>
|
|---|
| 165 | <div class="block">write data to xml file</div>
|
|---|
| 166 | </td>
|
|---|
| 167 | </tr>
|
|---|
| 168 | </table>
|
|---|
| 169 | <ul class="blockList">
|
|---|
| 170 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|---|
| 171 | <!-- -->
|
|---|
| 172 | </a>
|
|---|
| 173 | <h3>Methods inherited from class java.lang.Object</h3>
|
|---|
| 174 | <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|---|
| 175 | </ul>
|
|---|
| 176 | </li>
|
|---|
| 177 | </ul>
|
|---|
| 178 | </li>
|
|---|
| 179 | </ul>
|
|---|
| 180 | </div>
|
|---|
| 181 | <div class="details">
|
|---|
| 182 | <ul class="blockList">
|
|---|
| 183 | <li class="blockList">
|
|---|
| 184 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|---|
| 185 | <ul class="blockList">
|
|---|
| 186 | <li class="blockList"><a name="constructor.detail">
|
|---|
| 187 | <!-- -->
|
|---|
| 188 | </a>
|
|---|
| 189 | <h3>Constructor Detail</h3>
|
|---|
| 190 | <a name="XmlWriteStream-java.io.OutputStream-java.lang.String-">
|
|---|
| 191 | <!-- -->
|
|---|
| 192 | </a>
|
|---|
| 193 | <ul class="blockListLast">
|
|---|
| 194 | <li class="blockList">
|
|---|
| 195 | <h4>XmlWriteStream</h4>
|
|---|
| 196 | <pre>public XmlWriteStream(java.io.OutputStream out,
|
|---|
| 197 | java.lang.String topLabel)
|
|---|
| 198 | throws javax.xml.stream.XMLStreamException</pre>
|
|---|
| 199 | <dl>
|
|---|
| 200 | <dt><span class="paramLabel">Parameters:</span></dt>
|
|---|
| 201 | <dd><code>out</code> - the <code>OutputStream</code></dd>
|
|---|
| 202 | <dd><code>topLabel</code> - the top level element name, typically "Tournament" or
|
|---|
| 203 | "Session"</dd>
|
|---|
| 204 | <dt><span class="throwsLabel">Throws:</span></dt>
|
|---|
| 205 | <dd><code>javax.xml.stream.XMLStreamException</code></dd>
|
|---|
| 206 | </dl>
|
|---|
| 207 | </li>
|
|---|
| 208 | </ul>
|
|---|
| 209 | </li>
|
|---|
| 210 | </ul>
|
|---|
| 211 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 212 | <ul class="blockList">
|
|---|
| 213 | <li class="blockList"><a name="method.detail">
|
|---|
| 214 | <!-- -->
|
|---|
| 215 | </a>
|
|---|
| 216 | <h3>Method Detail</h3>
|
|---|
| 217 | <a name="write-java.lang.String-java.util.Map-">
|
|---|
| 218 | <!-- -->
|
|---|
| 219 | </a>
|
|---|
| 220 | <ul class="blockList">
|
|---|
| 221 | <li class="blockList">
|
|---|
| 222 | <h4>write</h4>
|
|---|
| 223 | <pre>public void write(java.lang.String name,
|
|---|
| 224 | java.util.Map<java.lang.Object,java.lang.Object> data)
|
|---|
| 225 | throws javax.xml.stream.XMLStreamException</pre>
|
|---|
| 226 | <div class="block">write data to xml file</div>
|
|---|
| 227 | <dl>
|
|---|
| 228 | <dt><span class="paramLabel">Parameters:</span></dt>
|
|---|
| 229 | <dd><code>name</code> - the name of the element to write.</dd>
|
|---|
| 230 | <dd><code>data</code> - a xml map of key-value pairs. The hashmap is written as a full
|
|---|
| 231 | element. Then each pair is checked. If the value is a
|
|---|
| 232 | <code>Map</code>, we call write recursively. Otherwise, we convert
|
|---|
| 233 | the key and value to <code>String</code> and write that element as
|
|---|
| 234 | an attribute.
|
|---|
| 235 |
|
|---|
| 236 | To improve layout, the hashmap's string values are written
|
|---|
| 237 | first.
|
|---|
| 238 |
|
|---|
| 239 | If you want to have multiple keys that look identical, use a
|
|---|
| 240 | <a href="../../../genius/core/xml/Key.html" title="class in genius.core.xml"><code>Key</code></a> as key.</dd>
|
|---|
| 241 | <dt><span class="throwsLabel">Throws:</span></dt>
|
|---|
| 242 | <dd><code>javax.xml.stream.XMLStreamException</code></dd>
|
|---|
| 243 | </dl>
|
|---|
| 244 | </li>
|
|---|
| 245 | </ul>
|
|---|
| 246 | <a name="close--">
|
|---|
| 247 | <!-- -->
|
|---|
| 248 | </a>
|
|---|
| 249 | <ul class="blockList">
|
|---|
| 250 | <li class="blockList">
|
|---|
| 251 | <h4>close</h4>
|
|---|
| 252 | <pre>public void close()</pre>
|
|---|
| 253 | <div class="block">Close the stream. After this you should dispose the XmlWriteStream as
|
|---|
| 254 | calls to write and close will fail.</div>
|
|---|
| 255 | </li>
|
|---|
| 256 | </ul>
|
|---|
| 257 | <a name="flush--">
|
|---|
| 258 | <!-- -->
|
|---|
| 259 | </a>
|
|---|
| 260 | <ul class="blockListLast">
|
|---|
| 261 | <li class="blockList">
|
|---|
| 262 | <h4>flush</h4>
|
|---|
| 263 | <pre>public void flush()
|
|---|
| 264 | throws javax.xml.stream.XMLStreamException</pre>
|
|---|
| 265 | <dl>
|
|---|
| 266 | <dt><span class="throwsLabel">Throws:</span></dt>
|
|---|
| 267 | <dd><code>javax.xml.stream.XMLStreamException</code></dd>
|
|---|
| 268 | </dl>
|
|---|
| 269 | </li>
|
|---|
| 270 | </ul>
|
|---|
| 271 | </li>
|
|---|
| 272 | </ul>
|
|---|
| 273 | </li>
|
|---|
| 274 | </ul>
|
|---|
| 275 | </div>
|
|---|
| 276 | </div>
|
|---|
| 277 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 278 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 279 | <div class="bottomNav"><a name="navbar.bottom">
|
|---|
| 280 | <!-- -->
|
|---|
| 281 | </a>
|
|---|
| 282 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|---|
| 283 | <a name="navbar.bottom.firstrow">
|
|---|
| 284 | <!-- -->
|
|---|
| 285 | </a>
|
|---|
| 286 | <ul class="navList" title="Navigation">
|
|---|
| 287 | <li><a href="../../../overview-summary.html">Overview</a></li>
|
|---|
| 288 | <li><a href="package-summary.html">Package</a></li>
|
|---|
| 289 | <li class="navBarCell1Rev">Class</li>
|
|---|
| 290 | <li><a href="class-use/XmlWriteStream.html">Use</a></li>
|
|---|
| 291 | <li><a href="package-tree.html">Tree</a></li>
|
|---|
| 292 | <li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|---|
| 293 | <li><a href="../../../index-all.html">Index</a></li>
|
|---|
| 294 | <li><a href="../../../help-doc.html">Help</a></li>
|
|---|
| 295 | </ul>
|
|---|
| 296 | </div>
|
|---|
| 297 | <div class="subNav">
|
|---|
| 298 | <ul class="navList">
|
|---|
| 299 | <li><a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml"><span class="typeNameLink">Prev Class</span></a></li>
|
|---|
| 300 | <li>Next Class</li>
|
|---|
| 301 | </ul>
|
|---|
| 302 | <ul class="navList">
|
|---|
| 303 | <li><a href="../../../index.html?genius/core/xml/XmlWriteStream.html" target="_top">Frames</a></li>
|
|---|
| 304 | <li><a href="XmlWriteStream.html" target="_top">No Frames</a></li>
|
|---|
| 305 | </ul>
|
|---|
| 306 | <ul class="navList" id="allclasses_navbar_bottom">
|
|---|
| 307 | <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|---|
| 308 | </ul>
|
|---|
| 309 | <div>
|
|---|
| 310 | <script type="text/javascript"><!--
|
|---|
| 311 | allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|---|
| 312 | if(window==top) {
|
|---|
| 313 | allClassesLink.style.display = "block";
|
|---|
| 314 | }
|
|---|
| 315 | else {
|
|---|
| 316 | allClassesLink.style.display = "none";
|
|---|
| 317 | }
|
|---|
| 318 | //-->
|
|---|
| 319 | </script>
|
|---|
| 320 | </div>
|
|---|
| 321 | <div>
|
|---|
| 322 | <ul class="subNavList">
|
|---|
| 323 | <li>Summary: </li>
|
|---|
| 324 | <li>Nested | </li>
|
|---|
| 325 | <li>Field | </li>
|
|---|
| 326 | <li><a href="#constructor.summary">Constr</a> | </li>
|
|---|
| 327 | <li><a href="#method.summary">Method</a></li>
|
|---|
| 328 | </ul>
|
|---|
| 329 | <ul class="subNavList">
|
|---|
| 330 | <li>Detail: </li>
|
|---|
| 331 | <li>Field | </li>
|
|---|
| 332 | <li><a href="#constructor.detail">Constr</a> | </li>
|
|---|
| 333 | <li><a href="#method.detail">Method</a></li>
|
|---|
| 334 | </ul>
|
|---|
| 335 | </div>
|
|---|
| 336 | <a name="skip.navbar.bottom">
|
|---|
| 337 | <!-- -->
|
|---|
| 338 | </a></div>
|
|---|
| 339 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 340 | </body>
|
|---|
| 341 | </html>
|
|---|
![(please configure the [header_logo] section in trac.ini)](/pubtrac/Genius/chrome/site/your_project_logo.png){kind=logo}
