| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlWriter (Apache Calcite 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.calcite.sql, interface: SqlWriter"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.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.5.1.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 evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| 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"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></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="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> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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.calcite.sql</a></div> |
| <h1 title="Interface SqlWriter" class="title">Interface SqlWriter</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="pretty/SqlPrettyWriter.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlWriter</span></div> |
| <div class="block">A <code>SqlWriter</code> is the target to construct a SQL statement from a |
| parse tree. It deals with dialect differences; for example, Oracle quotes |
| identifiers as <code>"scott"</code>, while SQL Server quotes them as <code> |
| [scott]</code>.</div> |
| </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="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="SqlWriter.Frame.html" class="type-name-link" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A Frame is a piece of generated text which shares a common indentation |
| level.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="SqlWriter.FrameType.html" class="type-name-link" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Frame type.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="SqlWriter.FrameTypeEnum.html" class="type-name-link" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Enumerates the types of frame.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="SqlWriter.SubQueryStyle.html" class="type-name-link" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Style of formatting sub-queries.</div> |
| </div> |
| </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>static final <a href="SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#COMMA" class="member-name-link">COMMA</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Comma operator.</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#dynamicParam(int)" class="member-name-link">dynamicParam</a><wbr>(int index)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints a dynamic parameter (e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)" class="member-name-link">endFunCall</a><wbr>(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Ends a list which is a call to a function.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#endList(org.apache.calcite.sql.SqlWriter.Frame)" class="member-name-link">endList</a><wbr>(@Nullable <a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Ends a list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)" class="member-name-link">fetchOffset</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDialect()" class="member-name-link">getDialect</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the dialect of SQL.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getIndentation()" class="member-name-link">getIndentation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the offset for each level of indentation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#identifier(java.lang.String,boolean)" class="member-name-link">identifier</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean quoted)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#inQuery()" class="member-name-link">inQuery</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isAlwaysUseParentheses()" class="member-name-link">isAlwaysUseParentheses</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether to enclose all expressions in parentheses, even if the |
| operator has high enough precedence that the parentheses are not |
| required.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClauseStartsLine()" class="member-name-link">isClauseStartsLine</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this writer should start each clause (e.g.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isKeywordsLowerCase()" class="member-name-link">isKeywordsLowerCase</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether to output all keywords (e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isQuoteAllIdentifiers()" class="member-name-link">isQuoteAllIdentifiers</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether this writer should quote all identifiers, even those |
| that do not contain mixed-case identifiers or punctuation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSelectListItemsOnSeparateLines()" class="member-name-link">isSelectListItemsOnSeparateLines</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether the items in the SELECT clause should each be on a |
| separate line.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#keyword(java.lang.String)" class="member-name-link">keyword</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints a sequence of keywords.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)" class="member-name-link">list</a><wbr>(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)" class="member-name-link">list</a><wbr>(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="#COMMA"><code>COMMA</code></a>).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#literal(java.lang.String)" class="member-name-link">literal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints a literal, exactly as provided.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newlineAndIndent()" class="member-name-link">newlineAndIndent</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints a new line, and indents.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#print(int)" class="member-name-link">print</a><wbr>(int x)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints an integer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#print(java.lang.String)" class="member-name-link">print</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Resets this writer so that it can format another expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resetSettings()" class="member-name-link">resetSettings</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Resets all properties to their default values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sep(java.lang.String)" class="member-name-link">sep</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#sep(java.lang.String,boolean)" class="member-name-link">sep</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep, |
| boolean printFirst)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Writes a list separator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setNeedWhitespace(boolean)" class="member-name-link">setNeedWhitespace</a><wbr>(boolean needWhitespace)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startFunCall(java.lang.String)" class="member-name-link">startFunCall</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> funName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Starts a list which is a call to a function.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startList(java.lang.String,java.lang.String)" class="member-name-link">startList</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> open, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> close)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Starts a list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)" class="member-name-link">startList</a><wbr>(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Starts a list with no opening string.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)" class="member-name-link">startList</a><wbr>(<a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> open, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> close)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Starts a list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)" class="member-name-link">topN</a><wbr>(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prints the TOP(n) clause.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toSqlString()" class="member-name-link">toSqlString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| </div> |
| </div> |
| </div> |
| </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="COMMA"> |
| <h3>COMMA</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a></span> <span class="element-name">COMMA</span></div> |
| <div class="block">Comma operator. |
| |
| <p>Defined in <code>SqlWriter</code> because it is only used while converting |
| <a href="SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> to SQL; |
| see <a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)"><code>list(FrameTypeEnum, SqlBinaryOperator, SqlNodeList)</code></a>. |
| |
| <p>The precedence of the comma operator is low but not zero. For |
| instance, this ensures parentheses in |
| <code>select x, (select * from foo order by z), y from t</code>.</div> |
| </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="reset()"> |
| <h3>reset</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">reset</span>()</div> |
| <div class="block">Resets this writer so that it can format another expression. Does not |
| affect formatting preferences (see <a href="#resetSettings()"><code>resetSettings()</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetSettings()"> |
| <h3>resetSettings</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">resetSettings</span>()</div> |
| <div class="block">Resets all properties to their default values.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDialect()"> |
| <h3>getDialect</h3> |
| <div class="member-signature"><span class="return-type"><a href="SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></span> <span class="element-name">getDialect</span>()</div> |
| <div class="block">Returns the dialect of SQL.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>SQL dialect</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSqlString()"> |
| <h3>toSqlString</h3> |
| <div class="member-signature"><span class="return-type"><a href="util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="element-name">toSqlString</span>()</div> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>SQL string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="literal(java.lang.String)"> |
| <h3>literal</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">literal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| <div class="block">Prints a literal, exactly as provided. Does not attempt to indent or |
| convert to upper or lower case. Does not add quotation marks. Adds |
| preceding whitespace if necessary.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyword(java.lang.String)"> |
| <h3>keyword</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">keyword</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| <div class="block">Prints a sequence of keywords. Must not start or end with space, but may |
| contain a space. For example, <code>keyword("SELECT")</code>, <code> |
| keyword("CHARACTER SET")</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="print(java.lang.String)"> |
| <h3>print</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">print</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="print(int)"> |
| <h3>print</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">print</span><wbr><span class="parameters">(int x)</span></div> |
| <div class="block">Prints an integer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - Integer</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="identifier(java.lang.String,boolean)"> |
| <h3>identifier</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">identifier</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| boolean quoted)</span></div> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The identifier name</dd> |
| <dd><code>quoted</code> - Whether this identifier was quoted in the original sql statement, |
| this may not be the only factor to decide whether this identifier |
| should be quoted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dynamicParam(int)"> |
| <h3>dynamicParam</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">dynamicParam</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block">Prints a dynamic parameter (e.g. <code>?</code> for default JDBC)</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"> |
| <h3>fetchOffset</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">fetchOffset</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"> |
| <h3>topN</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">topN</span><wbr><span class="parameters">(@Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block">Prints the TOP(n) clause.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"><code>fetchOffset(org.apache.calcite.sql.SqlNode, org.apache.calcite.sql.SqlNode)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newlineAndIndent()"> |
| <h3>newlineAndIndent</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">newlineAndIndent</span>()</div> |
| <div class="block">Prints a new line, and indents.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isQuoteAllIdentifiers()"> |
| <h3>isQuoteAllIdentifiers</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isQuoteAllIdentifiers</span>()</div> |
| <div class="block">Returns whether this writer should quote all identifiers, even those |
| that do not contain mixed-case identifiers or punctuation.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to quote all identifiers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isClauseStartsLine()"> |
| <h3>isClauseStartsLine</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isClauseStartsLine</span>()</div> |
| <div class="block">Returns whether this writer should start each clause (e.g. GROUP BY) on |
| a new line.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to start each clause on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSelectListItemsOnSeparateLines()"> |
| <h3>isSelectListItemsOnSeparateLines</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isSelectListItemsOnSeparateLines</span>()</div> |
| <div class="block">Returns whether the items in the SELECT clause should each be on a |
| separate line.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to put each SELECT clause item on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isKeywordsLowerCase()"> |
| <h3>isKeywordsLowerCase</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isKeywordsLowerCase</span>()</div> |
| <div class="block">Returns whether to output all keywords (e.g. SELECT, GROUP BY) in lower |
| case.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>whether to output SQL keywords in lower case</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startFunCall(java.lang.String)"> |
| <h3>startFunCall</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startFunCall</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> funName)</span></div> |
| <div class="block">Starts a list which is a call to a function.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"><code>endFunCall(Frame)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"> |
| <h3>endFunCall</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">endFunCall</span><wbr><span class="parameters">(<a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block">Ends a list which is a call to a function.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - Frame</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#startFunCall(java.lang.String)"><code>startFunCall(String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(java.lang.String,java.lang.String)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> open, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> close)</span></div> |
| <div class="block">Starts a list.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</span></div> |
| <div class="block">Starts a list with no opening string.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - Type of list. For example, a SELECT list will be |
| governed according to SELECT-list formatting preferences.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> open, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> close)</span></div> |
| <div class="block">Starts a list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - Type of list. For example, a SELECT list will be |
| governed according to SELECT-list formatting preferences.</dd> |
| <dd><code>open</code> - String to start the list; typically "(" or the empty |
| string.</dd> |
| <dd><code>close</code> - String to close the list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="endList(org.apache.calcite.sql.SqlWriter.Frame)"> |
| <h3>endList</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">endList</span><wbr><span class="parameters">(@Nullable <a href="SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block">Ends a list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - The frame which was created by <a href="#startList(java.lang.String,java.lang.String)"><code>startList(java.lang.String, java.lang.String)</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)"> |
| <h3>list</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="element-name">list</span><wbr><span class="parameters">(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</span></div> |
| <div class="block">Writes a list.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)"> |
| <h3>list</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type"><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="element-name">list</span><wbr><span class="parameters">(<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</span></div> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="#COMMA"><code>COMMA</code></a>).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sep(java.lang.String)"> |
| <h3>sep</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">sep</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep)</span></div> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sep</code> - List separator, typically ",".</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sep(java.lang.String,boolean)"> |
| <h3>sep</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">sep</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sep, |
| boolean printFirst)</span></div> |
| <div class="block">Writes a list separator.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sep</code> - List separator, typically ","</dd> |
| <dd><code>printFirst</code> - Whether to print the first occurrence of the separator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNeedWhitespace(boolean)"> |
| <h3>setNeedWhitespace</h3> |
| <div class="member-signature"><span class="annotations">@Pure |
| </span><span class="return-type">void</span> <span class="element-name">setNeedWhitespace</span><wbr><span class="parameters">(boolean needWhitespace)</span></div> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIndentation()"> |
| <h3>getIndentation</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getIndentation</span>()</div> |
| <div class="block">Returns the offset for each level of indentation. Default 4.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAlwaysUseParentheses()"> |
| <h3>isAlwaysUseParentheses</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isAlwaysUseParentheses</span>()</div> |
| <div class="block">Returns whether to enclose all expressions in parentheses, even if the |
| operator has high enough precedence that the parentheses are not |
| required. |
| |
| <p>For example, the parentheses are required in the expression <code>(a + |
| b) * c</code> because the '*' operator has higher precedence than the '+' |
| operator, and so without the parentheses, the expression would be |
| equivalent to <code>a + (b * c)</code>. The fully-parenthesized |
| expression, <code>((a + b) * c)</code> is unambiguous even if you don't |
| know the precedence of every operator.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="inQuery()"> |
| <h3>inQuery</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">inQuery</span>()</div> |
| <div class="block">Returns whether we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
