| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Template (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.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 methods = {"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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/calcite/util/Static.html" title="class in org.apache.calcite.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/util/TimestampString.html" title="class in org.apache.calcite.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/util/Template.html" target="_top">Frames</a></li> |
| <li><a href="Template.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.java.text.MessageFormat">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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.util</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/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">java.text.Format</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text">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><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Template</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text">MessageFormat</a></pre> |
| <div class="block">String template. |
| |
| <p>It is extended from <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text"><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 ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text">MessageFormat</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.Field.html?is-external=true" title="class or interface in java.text">MessageFormat.Field</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/Template.html#format-java.util.Map-">format</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> argMap)</code> |
| <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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/Template.html#formatByName-java.lang.String-java.util.Map-">formatByName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> argMap)</code> |
| <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/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/Template.html#getParameterNames--">getParameterNames</a></span>()</code> |
| <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="../../../../org/apache/calcite/util/Template.html" title="class in org.apache.calcite.util">Template</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/Template.html#of-java.lang.String-">of</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern)</code> |
| <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="../../../../org/apache/calcite/util/Template.html" title="class in org.apache.calcite.util">Template</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/util/Template.html#of-java.lang.String-java.util.Locale-">of</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code> |
| <div class="block">Creates a Template for the specified locale and |
| pattern.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.text.MessageFormat"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true" title="class or interface in java.text">MessageFormat</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#applyPattern-java.lang.String-" title="class or interface in java.text">applyPattern</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#clone--" title="class or interface in java.text">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.text">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#format-java.lang.Object:A-java.lang.StringBuffer-java.text.FieldPosition-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/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">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#format-java.lang.String-java.lang.Object...-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#formatToCharacterIterator-java.lang.Object-" title="class or interface in java.text">formatToCharacterIterator</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#getFormats--" title="class or interface in java.text">getFormats</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#getFormatsByArgumentIndex--" title="class or interface in java.text">getFormatsByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#getLocale--" title="class or interface in java.text">getLocale</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#hashCode--" title="class or interface in java.text">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#parse-java.lang.String-" title="class or interface in java.text">parse</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#parse-java.lang.String-java.text.ParsePosition-" title="class or interface in java.text">parse</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#parseObject-java.lang.String-java.text.ParsePosition-" title="class or interface in java.text">parseObject</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#setFormat-int-java.text.Format-" title="class or interface in java.text">setFormat</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#setFormatByArgumentIndex-int-java.text.Format-" title="class or interface in java.text">setFormatByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#setFormats-java.text.Format:A-" title="class or interface in java.text">setFormats</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#setFormatsByArgumentIndex-java.text.Format:A-" title="class or interface in java.text">setFormatsByArgumentIndex</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#setLocale-java.util.Locale-" title="class or interface in java.text">setLocale</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html?is-external=true#toPattern--" title="class or interface in java.text">toPattern</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.text.Format"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.text.<a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true" title="class or interface in java.text">Format</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#format-java.lang.Object-" title="class or interface in java.text">format</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/Format.html?is-external=true#parseObject-java.lang.String-" title="class or interface in java.text">parseObject</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="of-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../org/apache/calcite/util/Template.html" title="class in org.apache.calcite.util">Template</a> of(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the pattern is invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="of-java.lang.String-java.util.Locale-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre>public static <a href="../../../../org/apache/calcite/util/Template.html" title="class in org.apache.calcite.util">Template</a> of(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">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/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the pattern is invalid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="format-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>format</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the Format cannot format the given |
| object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="formatByName-java.lang.String-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>formatByName</h4> |
| <pre>public static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> formatByName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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="../../../../org/apache/calcite/util/Template.html#of-java.lang.String-"><code>Template</code></a>(pattern).<a href="../../../../org/apache/calcite/util/Template.html#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/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">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 name="getParameterNames--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getParameterNames</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <li><a href="../../../../org/apache/calcite/util/Static.html" title="class in org.apache.calcite.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/util/TimestampString.html" title="class in org.apache.calcite.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/util/Template.html" target="_top">Frames</a></li> |
| <li><a href="Template.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.classes.inherited.from.class.java.text.MessageFormat">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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |