| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>org.apache.sis.io (Apache SIS 1.3 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.sis.io"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.io package"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../sis.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.0.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <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="../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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> |
| <ul class="sub-nav-list-small"> |
| <li> |
| <p>Package:</p> |
| <ul> |
| <li><a href="#package-description">Description</a></li> |
| <li><a href="#related-package-summary">Related Packages</a></li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </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.apache.sis.io" class="title">Package org.apache.sis.io</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.sis.io</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Extensions to standard Java I/O (<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Reader.html" title="class or interface in java.io" class="external-link"><code>Reader</code></a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Writer.html" title="class or interface in java.io" class="external-link"><code>Writer</code></a>, |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link"><code>Appendable</code></a>) and <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link"><code>Format</code></a>. |
| Many classes defined in this package are filters applying on-the-fly formatting while writing |
| text to the output device. For example, <a href="LineAppender.html" title="class in org.apache.sis.io"><code>LineAppender</code></a> can wrap lines |
| to some maximal line length (e.g. 80 characters), and <a href="TableAppender.html" title="class in org.apache.sis.io"><code>TableAppender</code></a> |
| replaces all occurrence of <code>'\t'</code> by the amount of spaces needed for producing a tabular |
| output. |
| |
| <div class="note"><b>Note:</b> |
| One of the formatter classes defined in this package is a <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link"><code>java.text.Format</code></a> subclass. |
| While traditionally though as part of <code>text</code> packages, that <code>Format</code> is defined in this I/O package |
| because it can format to an <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link"><code>Appendable</code></a> and for consistency with the <a href="wkt/package-summary.html"><code>org.apache.sis.io.wkt</code></a> |
| package.</div> |
| |
| <h2>Unicode characters</h2> |
| Some formatters in this package make extensive use of Unicode characters. This may produce |
| unexpected results in a Windows console, unless the underlying output stream uses the correct |
| encoding (e.g. <code>new OutputStreamWriter(System.out, "Cp437")</code>). To display the appropriate |
| code page for a Windows console, type <code>chcp</code> on the command line. |
| |
| <h2>Supplementary Unicode characters</h2> |
| This package can handle the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Character.html#isSupplementaryCodePoint(int)" title="class or interface in java.lang" class="external-link">Unicode supplementary characters</a>.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| |
| <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="wkt/package-summary.html">org.apache.sis.io.wkt</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><cite>Well Known Text</cite> (WKT) parsing and formatting.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <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-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">Exception Classes</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="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class of <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.html" title="class or interface in java.text" class="external-link"><code>Format</code></a> implementations which delegate part of their work to other |
| <code>Format</code> instances.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="InvalidSeekException.html" title="class in org.apache.sis.io">InvalidSeekException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Thrown when an input stream or a channel cannot modify its position to the given value.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="IO.html" title="class in org.apache.sis.io">IO</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Utilities methods working on <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/package-summary.html" class="external-link"><code>java.io</code></a> objects.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LineAppender.html" title="class in org.apache.sis.io">LineAppender</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link"><code>Appendable</code></a> which can apply different kinds of reformatting that depend on the |
| <cite>End Of Line</cite> (EOL) occurrences.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TableAppender.html" title="class in org.apache.sis.io">TableAppender</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">An <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link"><code>Appendable</code></a> which formats the text as a table suitable for displaying in devices using |
| a monospaced font.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for parser and formatter of tabular data, providing control on line and column separators.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2010–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
