blob: c3c3d341b6b8cbe107aebe16a5b876fb373c48b4 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>TimeUnit (Apache Calcite Avatica 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="TimeUnit (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":9,"i3":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="class-use/TimeUnit.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.avatica.util</a></div>
<h2 title="Enum TimeUnit" class="title">Enum TimeUnit</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.avatica.util.TimeUnit</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>&gt;</code></dd>
</dl>
<hr>
<pre>public enum <span class="typeNameLabel">TimeUnit</span>
extends java.lang.Enum&lt;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>&gt;</pre>
<div class="block">Enumeration of time units used to construct an interval.
<p>Only <a href="#YEAR"><code>YEAR</code></a>, <a href="#MONTH"><code>MONTH</code></a>, <a href="#DAY"><code>DAY</code></a>,
<a href="#HOUR"><code>HOUR</code></a>, <a href="#MINUTE"><code>MINUTE</code></a>, <a href="#SECOND"><code>SECOND</code></a> can be the unit of a SQL
interval.
<p>The others (<a href="#QUARTER"><code>QUARTER</code></a>, <a href="#WEEK"><code>WEEK</code></a>, <a href="#MILLISECOND"><code>MILLISECOND</code></a>,
<a href="#DOW"><code>DOW</code></a>, <a href="#DOY"><code>DOY</code></a>, <a href="#EPOCH"><code>EPOCH</code></a>, <a href="#DECADE"><code>DECADE</code></a>, <a href="#CENTURY"><code>CENTURY</code></a>,
<a href="#MILLENNIUM"><code>MILLENNIUM</code></a>, <a href="#MICROSECOND"><code>MICROSECOND</code></a>, <a href="#NANOSECOND"><code>NANOSECOND</code></a>, <a href="#ISODOW"><code>ISODOW</code></a>
and <a href="#ISOYEAR"><code>ISOYEAR</code></a>) are convenient to use internally,
when converting to and from UNIX timestamps.
And also may be arguments to the <code>EXTRACT</code>, <code>TIMESTAMPADD</code> and
<code>TIMESTAMPDIFF</code> functions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#CENTURY">CENTURY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DAY">DAY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DECADE">DECADE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DOW">DOW</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#DOY">DOY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#EPOCH">EPOCH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#HOUR">HOUR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ISODOW">ISODOW</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ISOYEAR">ISOYEAR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MICROSECOND">MICROSECOND</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MILLENNIUM">MILLENNIUM</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MILLISECOND">MILLISECOND</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MINUTE">MINUTE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#MONTH">MONTH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#NANOSECOND">NANOSECOND</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#QUARTER">QUARTER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SECOND">SECOND</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#WEEK">WEEK</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#YEAR">YEAR</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.math.BigDecimal</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#multiplier">multiplier</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>char</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#separator">separator</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#yearMonth">yearMonth</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(int)">getValue</a></span>&#8203;(int&nbsp;ordinal)</code></th>
<td class="colLast">
<div class="block">Returns the TimeUnit associated with an ordinal.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidValue(java.math.BigDecimal)">isValidValue</a></span>&#8203;(java.math.BigDecimal&nbsp;field)</code></th>
<td class="colLast">
<div class="block">Returns whether a given value is valid for a field of this time unit.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="YEAR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>YEAR</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> YEAR</pre>
</li>
</ul>
<a id="MONTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MONTH</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> MONTH</pre>
</li>
</ul>
<a id="DAY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DAY</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> DAY</pre>
</li>
</ul>
<a id="HOUR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HOUR</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> HOUR</pre>
</li>
</ul>
<a id="MINUTE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MINUTE</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> MINUTE</pre>
</li>
</ul>
<a id="SECOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SECOND</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> SECOND</pre>
</li>
</ul>
<a id="QUARTER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>QUARTER</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> QUARTER</pre>
</li>
</ul>
<a id="ISOYEAR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ISOYEAR</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> ISOYEAR</pre>
</li>
</ul>
<a id="WEEK">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WEEK</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> WEEK</pre>
</li>
</ul>
<a id="MILLISECOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MILLISECOND</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> MILLISECOND</pre>
</li>
</ul>
<a id="MICROSECOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MICROSECOND</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> MICROSECOND</pre>
</li>
</ul>
<a id="NANOSECOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NANOSECOND</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> NANOSECOND</pre>
</li>
</ul>
<a id="DOW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOW</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> DOW</pre>
</li>
</ul>
<a id="ISODOW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ISODOW</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> ISODOW</pre>
</li>
</ul>
<a id="DOY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DOY</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> DOY</pre>
</li>
</ul>
<a id="EPOCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EPOCH</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> EPOCH</pre>
</li>
</ul>
<a id="DECADE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DECADE</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> DECADE</pre>
</li>
</ul>
<a id="CENTURY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CENTURY</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> CENTURY</pre>
</li>
</ul>
<a id="MILLENNIUM">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MILLENNIUM</h4>
<pre>public static final&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a> MILLENNIUM</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="yearMonth">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>yearMonth</h4>
<pre>public final&nbsp;boolean yearMonth</pre>
</li>
</ul>
<a id="separator">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>separator</h4>
<pre>public final&nbsp;char separator</pre>
</li>
</ul>
<a id="multiplier">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>multiplier</h4>
<pre>public final&nbsp;java.math.BigDecimal multiplier</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (TimeUnit c : TimeUnit.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="getValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre class="methodSignature">public static&nbsp;<a href="TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a>&nbsp;getValue&#8203;(int&nbsp;ordinal)</pre>
<div class="block">Returns the TimeUnit associated with an ordinal. The value returned
is null if the ordinal is not a member of the TimeUnit enumeration.</div>
</li>
</ul>
<a id="isValidValue(java.math.BigDecimal)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isValidValue</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isValidValue&#8203;(java.math.BigDecimal&nbsp;field)</pre>
<div class="block">Returns whether a given value is valid for a field of this time unit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>field</code> - Field value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether value</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="class-use/TimeUnit.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>