| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Template (Apache Calcite 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="Template (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":9}; |
| 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="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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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"> </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> <a href="package-summary.html">org.apache.calcite.util</a></div> |
| <h2 title="Class Template" class="title">Class Template</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">java.text.Format</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text" class="externalLink">java.text.MessageFormat</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.calcite.util.Template</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Cloneable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">Template</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text" class="externalLink">MessageFormat</a></pre> |
| <div class="block">String template. |
| |
| <p>It is extended from <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text" class="externalLink"><code>MessageFormat</code></a> to allow parameters |
| to be substituted by name as well as by position. |
| |
| <p>The following example, using MessageFormat, yields "Happy 64th birthday, |
| Ringo!": |
| |
| <blockquote>MessageFormat f = |
| new MessageFormat("Happy {0,number}th birthday, {1}!");<br> |
| Object[] args = {64, "Ringo"};<br> |
| System.out.println(f.format(args);</blockquote> |
| |
| <p>Here is the same example using a Template and named parameters: |
| |
| <blockquote>Template f = |
| new Template("Happy {age,number}th birthday, {name}!");<br> |
| Map<Object, Object> args = new HashMap<Object, Object>();<br> |
| args.put("age", 64);<br> |
| args.put("name", "Ringo");<br> |
| System.out.println(f.format(args);</blockquote> |
| |
| <p>Using a Template you can also use positional parameters: |
| |
| <blockquote>Template f = |
| new Template("Happy {age,number}th birthday, {name}!");<br> |
| Object[] args = {64, "Ringo"};<br> |
| System.out.println(f.format(args);</blockquote> |
| |
| <p>Or a hybrid; here, one argument is specified by name, another by position: |
| |
| <blockquote>Template f = |
| new Template("Happy {age,number}th birthday, {name}!");<br> |
| Map<Object, Object> args = new HashMap<Object, Object>();<br> |
| args.put(0, 64);<br> |
| args.put("name", "Ringo");<br> |
| System.out.println(f.format(args);</blockquote></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.calcite.util.Template">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.text.MessageFormat"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class java.text.<a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text" class="externalLink">MessageFormat</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.Field.html?is-external=true" title="class or interface in java.text" class="externalLink">MessageFormat.Field</a></code></li> |
| </ul> |
| </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(java.util.Map)">format</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> argMap)</code></th> |
| <td class="colLast"> |
| <div class="block">Formats a set of arguments to produce a string.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#formatByName(java.lang.String,java.util.Map)">formatByName</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> argMap)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Template with the given pattern and uses it |
| to format the given arguments.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterNames()">getParameterNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the names of the parameters, in the order that they appeared in |
| the template string.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Template.html" title="class in org.apache.calcite.util">Template</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.String)">of</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Template for the default locale and the |
| specified pattern.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="Template.html" title="class in org.apache.calcite.util">Template</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.String,java.util.Locale)">of</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a> locale)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Template for the specified locale and |
| pattern.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.text.MessageFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.text.<a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text" class="externalLink">MessageFormat</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#applyPattern(java.lang.String)" title="class or interface in java.text" class="externalLink">applyPattern</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#clone()" title="class or interface in java.text" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.text" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#format(java.lang.Object%5B%5D,java.lang.StringBuffer,java.text.FieldPosition)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#format(java.lang.Object,java.lang.StringBuffer,java.text.FieldPosition)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#format(java.lang.String,java.lang.Object...)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#formatToCharacterIterator(java.lang.Object)" title="class or interface in java.text" class="externalLink">formatToCharacterIterator</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#getFormats()" title="class or interface in java.text" class="externalLink">getFormats</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#getFormatsByArgumentIndex()" title="class or interface in java.text" class="externalLink">getFormatsByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#getLocale()" title="class or interface in java.text" class="externalLink">getLocale</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#hashCode()" title="class or interface in java.text" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#parse(java.lang.String)" title="class or interface in java.text" class="externalLink">parse</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#parse(java.lang.String,java.text.ParsePosition)" title="class or interface in java.text" class="externalLink">parse</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#parseObject(java.lang.String,java.text.ParsePosition)" title="class or interface in java.text" class="externalLink">parseObject</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#setFormat(int,java.text.Format)" title="class or interface in java.text" class="externalLink">setFormat</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#setFormatByArgumentIndex(int,java.text.Format)" title="class or interface in java.text" class="externalLink">setFormatByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#setFormats(java.text.Format%5B%5D)" title="class or interface in java.text" class="externalLink">setFormats</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#setFormatsByArgumentIndex(java.text.Format%5B%5D)" title="class or interface in java.text" class="externalLink">setFormatsByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#setLocale(java.util.Locale)" title="class or interface in java.text" class="externalLink">setLocale</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/MessageFormat.html?is-external=true#toPattern()" title="class or interface in java.text" class="externalLink">toPattern</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.text.Format"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.text.<a href="https://docs.oracle.com/javase/9/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text" class="externalLink">Format</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/text/Format.html?is-external=true#format(java.lang.Object)" title="class or interface in java.text" class="externalLink">format</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/text/Format.html?is-external=true#parseObject(java.lang.String)" title="class or interface in java.text" class="externalLink">parseObject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="of(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">public static <a href="Template.html" title="class in org.apache.calcite.util">Template</a> of​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern)</pre> |
| <div class="block">Creates a Template for the default locale and the |
| specified pattern.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern for this message format</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the pattern is invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="of(java.lang.String,java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">public static <a href="Template.html" title="class in org.apache.calcite.util">Template</a> of​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util" class="externalLink">Locale</a> locale)</pre> |
| <div class="block">Creates a Template for the specified locale and |
| pattern.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern for this message format</dd> |
| <dd><code>locale</code> - the locale for this message format</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the pattern is invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="format(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> format​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> argMap)</pre> |
| <div class="block">Formats a set of arguments to produce a string. |
| |
| <p>Arguments may appear in the map using named keys (of type String), or |
| positional keys (0-based ordinals represented either as type String or |
| Integer).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>argMap</code> - A map containing the arguments as (key, value) pairs</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Formatted string.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the Format cannot format the given |
| object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="formatByName(java.lang.String,java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>formatByName</h4> |
| <pre class="methodSignature">public static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> formatByName​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> argMap)</pre> |
| <div class="block">Creates a Template with the given pattern and uses it |
| to format the given arguments. This is equivalent to |
| <blockquote> |
| <code><a href="#of(java.lang.String)"><code>Template</code></a>(pattern).<a href="#format(java.util.Map)"><code>format(java.util.Map<java.lang.Object, java.lang.Object>)</code></a>(args)</code> |
| </blockquote></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - if the pattern is invalid, |
| or if an argument in the |
| <code>arguments</code> array is not of the |
| type expected by the format element(s) |
| that use it.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParameterNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getParameterNames</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getParameterNames()</pre> |
| <div class="block">Returns the names of the parameters, in the order that they appeared in |
| the template string.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>List of parameter names</dd> |
| </dl> |
| </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="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 class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |