| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (19) --> |
| <title>Symbols (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.wkt, class: Symbols"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.io.wkt.Symbols class"> |
| <meta name="keywords" content="SQUARE_BRACKETS"> |
| <meta name="keywords" content="CURLY_BRACKETS"> |
| <meta name="keywords" content="getDefault()"> |
| <meta name="keywords" content="getLocale()"> |
| <meta name="keywords" content="setLocale()"> |
| <meta name="keywords" content="getNumPairedBrackets()"> |
| <meta name="keywords" content="getOpeningBracket()"> |
| <meta name="keywords" content="getClosingBracket()"> |
| <meta name="keywords" content="setPairedBrackets()"> |
| <meta name="keywords" content="getNumPairedQuotes()"> |
| <meta name="keywords" content="getOpeningQuote()"> |
| <meta name="keywords" content="getClosingQuote()"> |
| <meta name="keywords" content="setPairedQuotes()"> |
| <meta name="keywords" content="getOpenSequence()"> |
| <meta name="keywords" content="getCloseSequence()"> |
| <meta name="keywords" content="setSequenceBrackets()"> |
| <meta name="keywords" content="getSeparator()"> |
| <meta name="keywords" content="setSeparator()"> |
| <meta name="keywords" content="containsElement()"> |
| <meta name="keywords" content="clone()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <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"> </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><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Symbols.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>Nested</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: </li> |
| <li>Nested | </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> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <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> |
| </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> <a href="package-summary.html">org.apache.sis.io.wkt</a></div> |
| <h1 title="Class Symbols" class="title">Class Symbols</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">Symbols</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <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> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Symbols</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a>, <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>, <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></span></div> |
| <div class="block">The set of symbols to use for <cite>Well Known Text</cite> (WKT) parsing and formatting. |
| The two constants defined in this class, namely <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a> and <a href="#CURLY_BRACKETS"><code>CURLY_BRACKETS</code></a>, |
| define the symbols for ISO 19162 compliant WKT formatting. Their properties are: |
| |
| <table class="sis"> |
| <caption>Standard WKT symbols</caption> |
| <tr> |
| <th>WKT aspect</th> |
| <th>Standard value</th> |
| <th>Comment</th> |
| </tr> |
| <tr> |
| <td>Locale for number format:</td> |
| <td><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"><code>Locale.ROOT</code></a></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>Bracket symbols:</td> |
| <td><code>[</code>…<code>]</code> or <code>(</code>…<code>)</code></td> |
| <td><span style="font-size: small"><b>Note:</b> the <code>[…]</code> brackets are common in referencing WKT, |
| while the <code>(…)</code> brackets are common in geometry WKT.</span></td> |
| </tr> |
| <tr> |
| <td>Quote symbols:</td> |
| <td><code>"</code>…<code>"</code></td> |
| <td><span style="font-size: small"><b>Note:</b> Apache SIS accepts also <code>“…”</code> quotes |
| for more readable <code>String</code> literals in Java code, but this is non-standard.</span></td> |
| </tr> |
| <tr> |
| <td>Sequence symbols:</td> |
| <td><code>{</code>…<code>}</code></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>Separator:</td> |
| <td><code>,</code></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| Users can create their own <code>Symbols</code> instance for parsing or formatting a WKT with different symbols.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.4</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="WKTFormat.html#getSymbols()"><code>WKTFormat.getSymbols()</code></a></li> |
| <li><a href="WKTFormat.html#setSymbols(org.apache.sis.io.wkt.Symbols)"><code>WKTFormat.setSymbols(Symbols)</code></a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.io.wkt.Symbols">Serialized Form</a></li> |
| </ul> |
| </dd> |
| |
| <p><font size="-1">Defined in the <code>sis-referencing</code> module</font></p> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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>static final <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#CURLY_BRACKETS" class="member-name-link">CURLY_BRACKETS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A set of symbols with values between parentheses, like <code>DATUM("WGS84")</code>.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#SQUARE_BRACKETS" class="member-name-link">SQUARE_BRACKETS</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">A set of symbols with values between square brackets, like <code>DATUM["WGS84"]</code>.</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(org.apache.sis.io.wkt.Symbols)" class="member-name-link">Symbols</a><wbr>(<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> symbols)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new set of WKT symbols initialized to a copy of the given symbols.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></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 <code>Symbols</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#containsElement(java.lang.CharSequence,java.lang.String)" class="member-name-link">containsElement</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> wkt, |
| <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> element)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the given element.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares this <code>Symbols</code> with the given object for equality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCloseSequence()" class="member-name-link">getCloseSequence</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 character used for closing a sequence of values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClosingBracket(int)" class="member-name-link">getClosingBracket</a><wbr>(int index)</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 closing bracket character at the given index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClosingQuote(int)" class="member-name-link">getClosingQuote</a><wbr>(int index)</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 closing quote character at the given index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDefault()" class="member-name-link">getDefault</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the default set of symbols.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale()" class="member-name-link">getLocale</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 locale for formatting dates and numbers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumPairedBrackets()" class="member-name-link">getNumPairedBrackets</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 number of paired brackets.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumPairedQuotes()" class="member-name-link">getNumPairedQuotes</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 number of paired quotes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpeningBracket(int)" class="member-name-link">getOpeningBracket</a><wbr>(int index)</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 opening bracket character at the given index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpeningQuote(int)" class="member-name-link">getOpeningQuote</a><wbr>(int index)</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 opening quote character at the given index.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpenSequence()" class="member-name-link">getOpenSequence</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 character used for opening a sequence of values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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="#getSeparator()" class="member-name-link">getSeparator</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 string used as a separator in a list of values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</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 hash code value for this object.</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="#setLocale(java.util.Locale)" class="member-name-link">setLocale</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> locale)</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 locale of decimal format symbols or other symbols.</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="#setPairedBrackets(java.lang.String,java.lang.String...)" class="member-name-link">setPairedBrackets</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> preferred, |
| <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>... alternatives)</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 opening and closing brackets to the given pairs.</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="#setPairedQuotes(java.lang.String,java.lang.String...)" class="member-name-link">setPairedQuotes</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> preferred, |
| <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>... alternatives)</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 opening and closing quotes to the given pairs.</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="#setSeparator(java.lang.String)" class="member-name-link">setSeparator</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> separator)</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 string to use as a separator in a list of values.</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="#setSequenceBrackets(int,int)" class="member-name-link">setSequenceBrackets</a><wbr>(int openSequence, |
| int closeSequence)</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 characters used for opening and closing a sequence of values.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <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#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#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="SQUARE_BRACKETS"> |
| <h3>SQUARE_BRACKETS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></span> <span class="element-name">SQUARE_BRACKETS</span></div> |
| <div class="block">A set of symbols with values between square brackets, like <code>DATUM["WGS84"]</code>. |
| This instance defines: |
| |
| <ul> |
| <li><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"><code>Locale.ROOT</code></a> for <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/text/DecimalFormatSymbols.html" title="class or interface in java.text" class="external-link">decimal format symbols</a>.</li> |
| <li>Square brackets by default, as in <code>DATUM["WGS84"]</code>, but accepting also curly brackets as in |
| <code>DATUM("WGS84")</code>. Both are legal WKT.</li> |
| <li>English quotation mark (<code>'"'</code>) by default, but accepting also “…” quotes |
| for more readable <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"><code>String</code></a> constants in Java code.</li> |
| <li>Coma separator followed by a space (<code>", "</code>).</li> |
| </ul> |
| |
| This is the most frequently used WKT format for referencing objects.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CURLY_BRACKETS"> |
| <h3>CURLY_BRACKETS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></span> <span class="element-name">CURLY_BRACKETS</span></div> |
| <div class="block">A set of symbols with values between parentheses, like <code>DATUM("WGS84")</code>. |
| This instance is identical to <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a> except that the default |
| brackets are the curly ones instead of the square ones (but both are still |
| accepted at parsing time). |
| |
| <p>This format is rare with referencing objects but common with geometry objects.</p></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="<init>(org.apache.sis.io.wkt.Symbols)"> |
| <h3>Symbols</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Symbols</span><wbr><span class="parameters">(<a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a> symbols)</span></div> |
| <div class="block">Creates a new set of WKT symbols initialized to a copy of the given symbols.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>symbols</code> - the symbols to copy.</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="getDefault()"> |
| <h3>getDefault</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></span> <span class="element-name">getDefault</span>()</div> |
| <div class="block">Returns the default set of symbols. |
| This is currently set to <a href="#SQUARE_BRACKETS"><code>SQUARE_BRACKETS</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the default set of symbols.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocale()"> |
| <h3>getLocale</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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></span> <span class="element-name">getLocale</span>()</div> |
| <div class="block">Returns the locale for formatting dates and numbers. |
| The default value is <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"><code>Locale.ROOT</code></a>. |
| |
| <h4>Relationship between <code>Symbols</code> locale and <code>WKTFormat</code> locale</h4> |
| The <code>WKTFormat.getLocale(Locale.DISPLAY)</code> property specifies the language to use when |
| formatting <a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link"><code>InternationalString</code></a> instances and can be set to any value. |
| On the contrary, the <code>Locale</code> property of this <code>Symbols</code> class controls |
| the decimal format symbols and is very rarely set to another locale than <code>Locale.ROOT</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../../util/Localized.html#getLocale()">getLocale</a></code> in interface <code><a href="../../util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the locale for dates and numbers.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="WKTFormat.html#getLocale(java.util.Locale.Category)"><code>WKTFormat.getLocale(Locale.Category)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLocale(java.util.Locale)"> |
| <h3>setLocale</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLocale</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> locale)</span></div> |
| <div class="block">Sets the locale of decimal format symbols or other symbols. |
| Note that any non-English locale is likely to produce WKT that do not conform to ISO 19162. |
| Such WKT can be used for human reading, but not for data export.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>locale</code> - the new symbols locale.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>Symbols</code> instance is immutable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumPairedBrackets()"> |
| <h3>getNumPairedBrackets</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getNumPairedBrackets</span>()</div> |
| <div class="block">Returns the number of paired brackets. For example if the WKT parser accepts both the |
| <code>[…]</code> and <code>(…)</code> bracket pairs, then this method returns 2.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of bracket pairs.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getOpeningBracket(int)"><code>getOpeningBracket(int)</code></a></li> |
| <li><a href="#getClosingBracket(int)"><code>getClosingBracket(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOpeningBracket(int)"> |
| <h3>getOpeningBracket</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getOpeningBracket</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Returns the opening bracket character at the given index. |
| Index 0 stands for the default bracket used at formatting time. |
| All other index are for optional brackets accepted at parsing time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - index of the opening bracket to get, from 0 to <a href="#getNumPairedBrackets()"><code>getNumPairedBrackets()</code></a> exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the opening bracket at the given index, as a Unicode code point.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClosingBracket(int)"> |
| <h3>getClosingBracket</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getClosingBracket</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Returns the closing bracket character at the given index. |
| Index 0 stands for the default bracket used at formatting time. |
| All other index are for optional brackets accepted at parsing time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - index of the closing bracket to get, from 0 to <a href="#getNumPairedBrackets()"><code>getNumPairedBrackets()</code></a> exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the closing bracket at the given index, as a Unicode code point.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPairedBrackets(java.lang.String,java.lang.String...)"> |
| <h3>setPairedBrackets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPairedBrackets</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> preferred, |
| <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>... alternatives)</span></div> |
| <div class="block">Sets the opening and closing brackets to the given pairs. |
| Each string shall contain exactly two code points (usually two characters). |
| The first code point is taken as the opening bracket, and the second code point as the closing bracket. |
| |
| <div class="note"><b>Example:</b> |
| The following code will instruct the WKT formatter to use the (…) pair of brackets at formatting time, |
| but still accept the more common […] pair of brackets at parsing time: |
| |
| <blockquote><pre>symbols.<b>setPairedBrackets</b>(<font color="orangered">"()"</font>, <font color="orangered">"[]"</font>);</pre></blockquote></div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>preferred</code> - the preferred pair of opening and closing quotes, used at formatting time.</dd> |
| <dd><code>alternatives</code> - alternative pairs of opening and closing quotes accepted at parsing time.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>Symbols</code> instance is immutable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumPairedQuotes()"> |
| <h3>getNumPairedQuotes</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getNumPairedQuotes</span>()</div> |
| <div class="block">Returns the number of paired quotes. For example if the WKT parser accepts both the |
| <code>"…"</code> and <code>“…”</code> quote pairs, then this method returns 2.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of quote pairs.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getOpeningQuote(int)"><code>getOpeningQuote(int)</code></a></li> |
| <li><a href="#getClosingQuote(int)"><code>getClosingQuote(int)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOpeningQuote(int)"> |
| <h3>getOpeningQuote</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getOpeningQuote</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Returns the opening quote character at the given index. |
| Index 0 stands for the default quote used at formatting time, which is usually <code>'"'</code>. |
| All other index are for optional quotes accepted at parsing time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - index of the opening quote to get, from 0 to <a href="#getNumPairedQuotes()"><code>getNumPairedQuotes()</code></a> exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the opening quote at the given index, as a Unicode code point.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClosingQuote(int)"> |
| <h3>getClosingQuote</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getClosingQuote</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Returns the closing quote character at the given index. |
| Index 0 stands for the default quote used at formatting time, which is usually <code>'"'</code>. |
| All other index are for optional quotes accepted at parsing time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>index</code> - index of the closing quote to get, from 0 to <a href="#getNumPairedQuotes()"><code>getNumPairedQuotes()</code></a> exclusive.</dd> |
| <dt>Returns:</dt> |
| <dd>the closing quote at the given index, as a Unicode code point.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">IndexOutOfBoundsException</a></code> - if the given index is out of bounds.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPairedQuotes(java.lang.String,java.lang.String...)"> |
| <h3>setPairedQuotes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPairedQuotes</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> preferred, |
| <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>... alternatives)</span></div> |
| <div class="block">Sets the opening and closing quotes to the given pairs. |
| Each string shall contain exactly two code points (usually two characters). |
| The first code point is taken as the opening quote, and the second code point as the closing quote. |
| |
| <div class="note"><b>Example:</b> |
| The following code will instruct the WKT formatter to use the prettier “…” quotation marks at formatting time |
| (especially useful for <code>String</code> constants in Java code), but still accept the standard "…" quotation marks |
| at parsing time: |
| |
| <blockquote><pre>symbols.<b>setPairedQuotes</b>(<font color="orangered">"“”"</font>, <font color="orangered">"\"</font>\<font color="orangered">""</font>);</pre></blockquote></div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>preferred</code> - the preferred pair of opening and closing quotes, used at formatting time.</dd> |
| <dd><code>alternatives</code> - alternative pairs of opening and closing quotes accepted at parsing time.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>Symbols</code> instance is immutable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOpenSequence()"> |
| <h3>getOpenSequence</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getOpenSequence</span>()</div> |
| <div class="block">Returns the character used for opening a sequence of values. |
| This is usually <code>'{'</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the character used for opening a sequence of values, as a Unicode code point.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCloseSequence()"> |
| <h3>getCloseSequence</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">getCloseSequence</span>()</div> |
| <div class="block">Returns the character used for closing a sequence of values. |
| This is usually <code>'}'</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the character used for closing a sequence of values, as a Unicode code point.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSequenceBrackets(int,int)"> |
| <h3>setSequenceBrackets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSequenceBrackets</span><wbr><span class="parameters">(int openSequence, |
| int closeSequence)</span></div> |
| <div class="block">Sets the characters used for opening and closing a sequence of values.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>openSequence</code> - the character for opening a sequence of values, as a Unicode code point.</dd> |
| <dd><code>closeSequence</code> - the character for closing a sequence of values, as a Unicode code point.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>Symbols</code> instance is immutable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSeparator()"> |
| <h3>getSeparator</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <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> <span class="element-name">getSeparator</span>()</div> |
| <div class="block">Returns the string used as a separator in a list of values. This is usually <code>", "</code>, |
| but may be different if a non-English locale is used for formatting numbers.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the string used as a separator in a list of values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSeparator(java.lang.String)"> |
| <h3>setSeparator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSeparator</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> separator)</span></div> |
| <div class="block">Sets the string to use as a separator in a list of values. |
| The given string will be used "as-is" at formatting time, |
| but leading and trailing spaces will be ignored at parsing time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>separator</code> - the new string to use as a separator in a list of values.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>Symbols</code> instance is immutable.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsElement(java.lang.CharSequence,java.lang.String)"> |
| <h3>containsElement</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">containsElement</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> wkt, |
| <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> element)</span></div> |
| <div class="block">Returns <code>true</code> if the given WKT contains at least one instance of the given element. |
| Invoking this method is equivalent to invoking <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html#contains(java.lang.CharSequence)" title="class or interface in java.lang" class="external-link"><code>String.contains(CharSequence)</code></a> except |
| for the following: |
| |
| <ul> |
| <li>The search is case-insensitive.</li> |
| <li>Characters between <a href="#getOpeningQuote(int)">opening quotes</a> and |
| <a href="#getClosingQuote(int)">closing quotes</a> are ignored.</li> |
| <li>The element found in the given WKT cannot be preceded by other |
| <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Character.html#isUnicodeIdentifierPart(int)" title="class or interface in java.lang" class="external-link">Unicode identifier characters</a>.</li> |
| <li>The element found in the given WKT must be followed, ignoring space, by an |
| <a href="#getOpeningBracket(int)">opening bracket</a>.</li> |
| </ul> |
| |
| The purpose of this method is to guess some characteristics about the encoded object without |
| the cost of a full WKT parsing. |
| |
| <div class="note"><b>Example:</b> |
| <code>containsElement(wkt, "AXIS")</code> returns <code>true</code> if the given WKT contains at least |
| one instance of the <code>AXIS[…]</code> element, ignoring case.</div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>wkt</code> - the WKT to inspect.</dd> |
| <dd><code>element</code> - the element to search for.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the given WKT contains at least one instance of the given element.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clone()"> |
| <h3>clone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Symbols.html" title="class in org.apache.sis.io.wkt">Symbols</a></span> <span class="element-name">clone</span>()</div> |
| <div class="block">Returns a clone of this <code>Symbols</code>. |
| The returned instance is modifiable (i.e. setter methods will not throw <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>).</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code> in class <code><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></code></dd> |
| <dt>Returns:</dt> |
| <dd>a modifiable clone of this <code>Symbols</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> other)</span></div> |
| <div class="block">Compares this <code>Symbols</code> with the given object for equality.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><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></code> in class <code><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></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>other</code> - the object to compare with this <code>Symbols</code>.</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if both objects are equal.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Returns a hash code value for this object.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| <dt>Returns:</dt> |
| <dd>a hash code value.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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> |