Google Git
Sign in
apache / calcite-site / f3651d86b6f63f8b6bbb735c74220c093b7bf506 / . / apidocs / org / apache / calcite / util / NlsString.html
blob: 847868a4d942af94378f88fad6404ac05006df3f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>NlsString (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NlsString (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NlsString.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.util</a></div>
<h2 title="Class NlsString" class="title">Class NlsString</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.util.NlsString</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Cloneable</code>, <code>java.lang.Comparable&lt;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&gt;</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">NlsString</span>
extends java.lang.Object
implements java.lang.Comparable&lt;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&gt;, java.lang.Cloneable</pre>
<div class="block">A string, optionally with <code>character set</code> and
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql"><code>SqlCollation</code></a>. It is immutable.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private org.apache.calcite.avatica.util.ByteString</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bytesValue">bytesValue</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.nio.charset.Charset</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#charset">charset</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#charsetName">charsetName</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collation">collation</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static com.google.common.cache.LoadingCache&lt;<a href="Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;org.apache.calcite.avatica.util.ByteString,&#8203;java.nio.charset.Charset&gt;,&#8203;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DECODE_MAP">DECODE_MAP</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stringValue">stringValue</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,java.lang.String,org.apache.calcite.sql.SqlCollation)">NlsString</a></span>&#8203;(java.lang.String&nbsp;stringValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</code></th>
<td class="colLast">
<div class="block">Easy constructor for Java string.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String,org.apache.calcite.avatica.util.ByteString,java.lang.String,org.apache.calcite.sql.SqlCollation)">NlsString</a></span>&#8203;(java.lang.String&nbsp;stringValue,
org.apache.calcite.avatica.util.ByteString&nbsp;bytesValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</code></th>
<td class="colLast">
<div class="block">Internal constructor; other constructors must call it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.avatica.util.ByteString,java.lang.String,org.apache.calcite.sql.SqlCollation)">NlsString</a></span>&#8203;(org.apache.calcite.avatica.util.ByteString&nbsp;bytesValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</code></th>
<td class="colLast">
<div class="block">Creates a string in a specified character set.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asSql(boolean,boolean)">asSql</a></span>&#8203;(boolean&nbsp;prefix,
boolean&nbsp;suffix)</code></th>
<td class="colLast">
<div class="block">Returns the string quoted for SQL, for example <code>_ISO-8859-1'is it a
plane? no it''s superman!'</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone()">clone</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.apache.calcite.util.NlsString)">compareTo</a></span>&#8203;(<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&nbsp;other)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#concat(java.util.List)">concat</a></span>&#8203;(java.util.List&lt;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&gt;&nbsp;args)</code></th>
<td class="colLast">
<div class="block">Concatenates some <a href="NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a> objects.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(java.lang.String)">copy</a></span>&#8203;(java.lang.String&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Creates a copy of this <code>NlsString</code> with different content but same
charset and collation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.nio.charset.Charset</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharset()">getCharset</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCharsetName()">getCharsetName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollation()">getCollation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue()">getValue</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>org.apache.calcite.avatica.util.ByteString</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueBytes()">getValueBytes</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the value as a <code>ByteString</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rtrim()">rtrim</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a string the same as this but with spaces trimmed from the
right.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the string quoted for SQL, for example <code>_ISO-8859-1'is it a
plane? no it''s superman!'</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="DECODE_MAP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DECODE_MAP</h4>
<pre>private static final&nbsp;com.google.common.cache.LoadingCache&lt;<a href="Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;org.apache.calcite.avatica.util.ByteString,&#8203;java.nio.charset.Charset&gt;,&#8203;java.lang.String&gt; DECODE_MAP</pre>
</li>
</ul>
<a id="stringValue">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stringValue</h4>
<pre>private final&nbsp;java.lang.String stringValue</pre>
</li>
</ul>
<a id="bytesValue">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bytesValue</h4>
<pre>private final&nbsp;org.apache.calcite.avatica.util.ByteString bytesValue</pre>
</li>
</ul>
<a id="charsetName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charsetName</h4>
<pre>private final&nbsp;java.lang.String charsetName</pre>
</li>
</ul>
<a id="charset">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>charset</h4>
<pre>private final&nbsp;java.nio.charset.Charset charset</pre>
</li>
</ul>
<a id="collation">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>collation</h4>
<pre>private final&nbsp;<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a> collation</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.calcite.avatica.util.ByteString,java.lang.String,org.apache.calcite.sql.SqlCollation)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NlsString</h4>
<pre>public&nbsp;NlsString&#8203;(org.apache.calcite.avatica.util.ByteString&nbsp;bytesValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</pre>
<div class="block">Creates a string in a specified character set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytesValue</code> - Byte array constant, must not be null</dd>
<dd><code>charsetName</code> - Name of the character set, must not be null</dd>
<dd><code>collation</code> - Collation, may be null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.nio.charset.IllegalCharsetNameException</code> - If the given charset name is illegal</dd>
<dd><code>java.nio.charset.UnsupportedCharsetException</code> - If no support for the named charset
is available in this instance of the Java virtual machine</dd>
<dd><code>java.lang.RuntimeException</code> - If the given value cannot be represented in the
given charset</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,java.lang.String,org.apache.calcite.sql.SqlCollation)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NlsString</h4>
<pre>public&nbsp;NlsString&#8203;(java.lang.String&nbsp;stringValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</pre>
<div class="block">Easy constructor for Java string.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stringValue</code> - String constant, must not be null</dd>
<dd><code>charsetName</code> - Name of the character set, may be null</dd>
<dd><code>collation</code> - Collation, may be null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.nio.charset.IllegalCharsetNameException</code> - If the given charset name is illegal</dd>
<dd><code>java.nio.charset.UnsupportedCharsetException</code> - If no support for the named charset
is available in this instance of the Java virtual machine</dd>
<dd><code>java.lang.RuntimeException</code> - If the given value cannot be represented in the
given charset</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String,org.apache.calcite.avatica.util.ByteString,java.lang.String,org.apache.calcite.sql.SqlCollation)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NlsString</h4>
<pre>private&nbsp;NlsString&#8203;(java.lang.String&nbsp;stringValue,
org.apache.calcite.avatica.util.ByteString&nbsp;bytesValue,
java.lang.String&nbsp;charsetName,
<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;collation)</pre>
<div class="block">Internal constructor; other constructors must call it.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="compareTo(org.apache.calcite.util.NlsString)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;compareTo&#8203;(<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&nbsp;other)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="getCharsetName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharsetName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getCharsetName()</pre>
</li>
</ul>
<a id="getCharset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharset</h4>
<pre class="methodSignature">public&nbsp;java.nio.charset.Charset&nbsp;getCharset()</pre>
</li>
</ul>
<a id="getCollation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCollation</h4>
<pre class="methodSignature">public&nbsp;<a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql">SqlCollation</a>&nbsp;getCollation()</pre>
</li>
</ul>
<a id="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getValue()</pre>
</li>
</ul>
<a id="rtrim()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rtrim</h4>
<pre class="methodSignature">public&nbsp;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&nbsp;rtrim()</pre>
<div class="block">Returns a string the same as this but with spaces trimmed from the
right.</div>
</li>
</ul>
<a id="asSql(boolean,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asSql</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;asSql&#8203;(boolean&nbsp;prefix,
boolean&nbsp;suffix)</pre>
<div class="block">Returns the string quoted for SQL, for example <code>_ISO-8859-1'is it a
plane? no it''s superman!'</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prefix</code> - if true, prefix the character set name</dd>
<dd><code>suffix</code> - if true, suffix the collation clause</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the quoted string</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns the string quoted for SQL, for example <code>_ISO-8859-1'is it a
plane? no it''s superman!'</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="concat(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>concat</h4>
<pre class="methodSignature">public static&nbsp;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&nbsp;concat&#8203;(java.util.List&lt;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&gt;&nbsp;args)</pre>
<div class="block">Concatenates some <a href="NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a> objects. The result has the charset
and collation of the first element. The other elements must have matching
(or null) charset and collation. Concatenates all at once, not pairwise,
to avoid string copies.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - array of <a href="NlsString.html" title="class in org.apache.calcite.util"><code>NlsString</code></a> to be concatenated</dd>
</dl>
</li>
</ul>
<a id="copy(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre class="methodSignature">public&nbsp;<a href="NlsString.html" title="class in org.apache.calcite.util">NlsString</a>&nbsp;copy&#8203;(java.lang.String&nbsp;value)</pre>
<div class="block">Creates a copy of this <code>NlsString</code> with different content but same
charset and collation.</div>
</li>
</ul>
<a id="getValueBytes()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getValueBytes</h4>
<pre class="methodSignature">public&nbsp;org.apache.calcite.avatica.util.ByteString&nbsp;getValueBytes()</pre>
<div class="block">Returns the value as a <code>ByteString</code>.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NlsString.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>