org/apache/sis/io/TabularFormat.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>TabularFormat (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, class: TabularFormat">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.io.TabularFormat class">
 <meta name="keywords" content="lineSeparator">
 <meta name="keywords" content="columnSeparator">
 <meta name="keywords" content="fillCharacter">
 <meta name="keywords" content="beforeFill">
 <meta name="keywords" content="omitTrailingNulls">
 <meta name="keywords" content="getLineSeparator()">
 <meta name="keywords" content="setLineSeparator()">
 <meta name="keywords" content="getColumnSeparatorPattern()">
 <meta name="keywords" content="setColumnSeparatorPattern()">
 <meta name="keywords" content="getColumnSeparatorMatcher()">
 <meta name="keywords" content="clone()">
 <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="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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/TabularFormat.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#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li><a href="#nested-class-summary">Nested</a></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>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <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>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</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">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.io</a></div>
 <h1 title="Class TabularFormat" class="title">Class TabularFormat&lt;T&gt;</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance"><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">Format</a>
 <div class="inheritance"><a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a>&lt;T&gt;
 <div class="inheritance">TabularFormat&lt;T&gt;</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>Type Parameters:</dt>
 <dd><code>T</code> - the base type of objects parsed and formatted by this class.</dd>
 </dl>
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Direct Known Subclasses:</dt>
 <dd><code><a href="../feature/FeatureFormat.html" title="class in org.apache.sis.feature">FeatureFormat</a></code>, <code><a href="../referencing/gazetteer/LocationFormat.html" title="class in org.apache.sis.referencing.gazetteer">LocationFormat</a></code>, <code><a href="../parameter/ParameterFormat.html" title="class in org.apache.sis.parameter">ParameterFormat</a></code>, <code><a href="../math/StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></code>, <code><a href="../util/collection/TreeTableFormat.html" title="class in org.apache.sis.util.collection">TreeTableFormat</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">TabularFormat&lt;T&gt;</span>
 <span class="extends-implements">extends <a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a>&lt;T&gt;</span></div>
 <div class="block">Base class for parser and formatter of tabular data, providing control on line and column separators.
  The line separator is specified by a string. But the column separator is specified by a pattern which
  provide some control on the character to repeat, and on the strings to insert before and after the
  repeated character. See the following methods for details:

  <ul>
    <li><a href="#setLineSeparator(java.lang.String)"><code>setLineSeparator(String)</code></a></li>
    <li><a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a></li>
  </ul>

  <h2>Note for subclass implementions</h2>
  This base class takes care of splitting a column separator pattern into its components
  (<a href="#beforeFill"><code>beforeFill</code></a>, <a href="#fillCharacter"><code>fillCharacter</code></a> and <a href="#columnSeparator"><code>columnSeparator</code></a>)
  for easier usage in <code>format(…)</code> method implementations.
  Subclasses can use those fields like below:

  <p><b>Formatting table without border:</b></p>
  <blockquote><pre>TableAppender table = <font color="green">new</font> <b>TableAppender</b>(out, <font color="orangered">""</font>);
 <i><font color="gray">// ... do some work, then add a column separator:</font></i>
 table.<b>append</b>(beforeFill);
 table.<b>nextColumn</b>(fillCharacter);
 table.<b>append</b>(columnSeparator);</pre></blockquote>

  <p><b>Formatting table with a border:</b></p>
  <blockquote><pre>TableAppender table = <font color="green">new</font> <b>TableAppender</b>(out, columnSeparator);
 <i><font color="gray">// ... do some work, then add a column separator:</font></i>
 table.<b>append</b>(beforeFill);
 table.<b>nextColumn</b>(fillCharacter);</pre></blockquote></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.3</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="TableAppender.html" title="class in org.apache.sis.io"><code>TableAppender</code></a></li>
 <li><a href="../../../../serialized-form.html#org.apache.sis.io.TabularFormat">Serialized Form</a></li>
 </ul>
 </dd>

 <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
 </dl>
 </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="inherited-list">
 <h2 id="nested-classes-inherited-from-class-java.text.Format">Nested classes/interfaces inherited from class&nbsp;<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">Format</a></h2>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.Field.html" title="class or interface in java.text" class="external-link">Format.Field</a></code></div>
 </section>
 </li>
 <!-- =========== 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 <a href="https://docs.oracle.com/en/java/javase/16/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="#beforeFill" class="member-name-link">beforeFill</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The string to write before the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.</div>
 </div>
 <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/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"><code><a href="#columnSeparator" class="member-name-link">columnSeparator</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">The string to write after the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.</div>
 </div>
 <div class="col-first even-row-color"><code>protected char</code></div>
 <div class="col-second even-row-color"><code><a href="#fillCharacter" class="member-name-link">fillCharacter</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">The character to repeat after the content of a cell for alignment with the next column.</div>
 </div>
 <div class="col-first odd-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/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"><code><a href="#lineSeparator" class="member-name-link">lineSeparator</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">The line separator to use for formatting the tree.</div>
 </div>
 <div class="col-first even-row-color"><code>protected boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#omitTrailingNulls" class="member-name-link">omitTrailingNulls</a></code></div>
 <div class="col-last even-row-color">
 <div class="block"><code>true</code> if the trailing <code>null</code> values shall be omitted at formatting time.</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.util.Locale,java.util.TimeZone)" class="member-name-link">TabularFormat</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a>&nbsp;timezone)</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new tabular format.</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="TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<a href="TabularFormat.html" title="type parameter in TabularFormat">T</a>&gt;</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">Returns a clone of this format.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Matcher.html" title="class or interface in java.util.regex" class="external-link">Matcher</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColumnSeparatorMatcher(java.lang.CharSequence)" class="member-name-link">getColumnSeparatorMatcher</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;text)</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 matcher for the column separators in the given text.</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/16/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="#getColumnSeparatorPattern()" class="member-name-link">getColumnSeparatorPattern</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 the pattern of characters used in column separators.</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/16/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="#getLineSeparator()" class="member-name-link">getLineSeparator</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 the current line separator.</div>
 </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="#setColumnSeparatorPattern(java.lang.String)" class="member-name-link">setColumnSeparatorPattern</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pattern)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the pattern of the characters to insert between the columns.</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="#setLineSeparator(java.lang.String)" class="member-name-link">setLineSeparator</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;separator)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Sets the line separator.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-CompoundFormat">Methods inherited from class&nbsp;<a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a></h3>
 <code><a href="CompoundFormat.html#createFormat(java.lang.Class)">createFormat</a>, <a href="CompoundFormat.html#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)">format</a>, <a href="CompoundFormat.html#format(T,java.lang.Appendable)">format</a>, <a href="CompoundFormat.html#getFormat(java.lang.Class)">getFormat</a>, <a href="CompoundFormat.html#getLocale()">getLocale</a>, <a href="CompoundFormat.html#getLocale(java.util.Locale.Category)">getLocale</a>, <a href="CompoundFormat.html#getTimeZone()">getTimeZone</a>, <a href="CompoundFormat.html#getValueType()">getValueType</a>, <a href="CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)">parse</a>, <a href="CompoundFormat.html#parseObject(java.lang.String)">parseObject</a>, <a href="CompoundFormat.html#parseObject(java.lang.String,java.text.ParsePosition)">parseObject</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Format">Methods inherited from class&nbsp;<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">Format</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.html#format(java.lang.Object)" title="class or interface in java.text" class="external-link">format</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/Format.html#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="external-link">formatToCharacterIterator</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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/16/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="lineSeparator">
 <h3>lineSeparator</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">lineSeparator</span></div>
 <div class="block">The line separator to use for formatting the tree.
  The default value is system-dependent.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#getLineSeparator()"><code>getLineSeparator()</code></a></li>
 <li><a href="#setLineSeparator(java.lang.String)"><code>setLineSeparator(String)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="columnSeparator">
 <h3>columnSeparator</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">columnSeparator</span></div>
 <div class="block">The string to write after the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.
  This is the sequence of characters after the "<code>[ ]</code>" pair of brackets in the
  pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="fillCharacter">
 <h3>fillCharacter</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">char</span>&nbsp;<span class="element-name">fillCharacter</span></div>
 <div class="block">The character to repeat after the content of a cell for alignment with the next column.
  This is the character between the "<code>[ ]</code>" pair of brackets in the pattern given
  to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.

  <p>Subclasses will typically use this value in calls to <a href="TableAppender.html#nextColumn(char)"><code>TableAppender.nextColumn(char)</code></a>.</p></div>
 </section>
 </li>
 <li>
 <section class="detail" id="beforeFill">
 <h3>beforeFill</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">beforeFill</span></div>
 <div class="block">The string to write before the <a href="#fillCharacter"><code>fillCharacter</code></a>, or an empty string if none.
  This is the sequence of characters before the "<code>[ ]</code>" pair of brackets in the
  pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="omitTrailingNulls">
 <h3>omitTrailingNulls</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">omitTrailingNulls</span></div>
 <div class="block"><code>true</code> if the trailing <code>null</code> values shall be omitted at formatting time.
  This flag is controlled by the presence or absence of the <code>'?'</code> character at the
  beginning of the pattern given to the <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a> method.</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="&lt;init&gt;(java.util.Locale,java.util.TimeZone)">
 <h3>TabularFormat</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TabularFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a>&nbsp;locale,
  <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a>&nbsp;timezone)</span></div>
 <div class="block">Creates a new tabular format.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>locale</code> - the locale to use for numbers, dates and angles formatting,
                    or <code>null</code> for the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Locale.html#ROOT" title="class or interface in java.util" class="external-link">root locale</a>.</dd>
 <dd><code>timezone</code> - the timezone, or <code>null</code> for UTC.</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="getLineSeparator()">
 <h3>getLineSeparator</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getLineSeparator</span>()</div>
 <div class="block">Returns the current line separator. The default value is system-dependent.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the current line separator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setLineSeparator(java.lang.String)">
 <h3>setLineSeparator</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setLineSeparator</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;separator)</span></div>
 <div class="block">Sets the line separator. Cannot be a null or empty string.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>separator</code> - the new line separator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getColumnSeparatorPattern()">
 <h3>getColumnSeparatorPattern</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getColumnSeparatorPattern</span>()</div>
 <div class="block">Returns the pattern of characters used in column separators. Those characters will be used
  only if more than one column is formatted. See <a href="#setColumnSeparatorPattern(java.lang.String)"><code>setColumnSeparatorPattern(String)</code></a>
  for a description of the pattern syntax.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>the pattern of the current column separator.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="setColumnSeparatorPattern(java.lang.String)">
 <h3>setColumnSeparatorPattern</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setColumnSeparatorPattern</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pattern)</span>
                                throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
 <div class="block">Sets the pattern of the characters to insert between the columns. The pattern shall contain
  exactly one occurrence of the <code>"[ ]"</code> pair of bracket, with exactly one character
  between them. This character will be repeated as many time as needed for columns alignment.

  <p>The formatting pattern can optionally be followed by a regular expression to be used at
  parsing time. If omitted, the parsing pattern will be inferred from the formatting pattern.
  If specified, then the <a href="CompoundFormat.html#parse(java.lang.CharSequence,java.text.ParsePosition)"><code>parse</code></a> method will invoke
  the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Matcher.html#find()" title="class or interface in java.util.regex" class="external-link"><code>Matcher.find()</code></a> method for determining the column boundaries.</p>

  <p>The characters listed below have special meaning in the pattern.
  Other characters are appended <cite>as-is</cite> between the columns.</p>

  <table class="sis">
    <caption>Reserved characters</caption>
    <tr><th>Character(s)</th> <th>Meaning</th></tr>
    <tr><td><code>'?'</code></td>  <td>Omit the column separator for trailing null values.</td></tr>
    <tr><td><code>"[ ]"</code></td><td>Repeat the character between bracket as needed.</td></tr>
    <tr><td><code>'/'</code></td>  <td>Separate the formatting pattern from the parsing pattern.</td></tr>
    <tr><td><code>'\\'</code></td> <td>Escape any of the characters listed in this table.</td></tr>
  </table>

  <h4>Restrictions</h4>
  <ul>
    <li>If present, <code>'?'</code> shall be the first character in the pattern.</li>
    <li>The repeated character (specified inside the pair of brackets) is mandatory.</li>
    <li>In the current implementation, the repeated character must be in the
        Basic Multilanguage Plane.</li>
    <li>If <code>'/'</code> is present, anything on its right side shall be compliant
        with the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link"><code>Pattern</code></a> syntax.</li>
  </ul>

  <div class="note"><b>Example:</b>
  The <code>"?……[…] "</code> pattern means <cite>"If the next value is non-null, then insert the
  <code>"……"</code> string, repeat the <code>'…'</code> character as many time as needed (may be zero),
  then insert a space"</cite>.
  </div></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>pattern</code> - the pattern of the new column separator.</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the given pattern is illegal.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getColumnSeparatorMatcher(java.lang.CharSequence)">
 <h3>getColumnSeparatorMatcher</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Matcher.html" title="class or interface in java.util.regex" class="external-link">Matcher</a></span>&nbsp;<span class="element-name">getColumnSeparatorMatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;text)</span></div>
 <div class="block">Returns a matcher for the column separators in the given text.
  This method is invoked by subclasses in their <code>parse(…)</code> implementations.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>text</code> - the text for which to get a matcher.</dd>
 <dt>Returns:</dt>
 <dd>a matcher for the column separators in the given text.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="clone()">
 <h3>clone</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TabularFormat.html" title="class in org.apache.sis.io">TabularFormat</a>&lt;<a href="TabularFormat.html" title="type parameter in TabularFormat">T</a>&gt;</span>&nbsp;<span class="element-name">clone</span>()</div>
 <div class="block">Returns a clone of this format.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="CompoundFormat.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="CompoundFormat.html" title="class in org.apache.sis.io">CompoundFormat</a>&lt;<a href="TabularFormat.html" title="type parameter in TabularFormat">T</a>&gt;</code></dd>
 <dt>Returns:</dt>
 <dd>a clone of this format.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>