| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Literal</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.5.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="Literal"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":1,"i2":1,"i3":1,"i4":1,"i5":1,"i6":1,"i7":1,"i8":1,"i9":1,"i10":1,"i11":6,"i12":18,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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> |
| <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>Nested | </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.iceberg.expressions</a></div> |
| <h2 title="Interface Literal" class="title">Interface Literal<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The Java type of the value wrapped by a <a href="Literal.html" title="interface in org.apache.iceberg.expressions"><code>Literal</code></a></dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Literal<T></span> |
| extends java.io.Serializable</pre> |
| <div class="block">Represents a literal fixed value in an expression predicate</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>java.util.Comparator<<a href="Literal.html" title="type parameter in Literal">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#comparator()">comparator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return a <code>Comparator</code> for values.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Boolean></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(boolean)">of</a></span>​(boolean value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.nio.ByteBuffer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(byte%5B%5D)">of</a></span>​(byte[] value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Double></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(double)">of</a></span>​(double value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Float></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(float)">of</a></span>​(float value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Integer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(int)">of</a></span>​(int value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Long></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(long)">of</a></span>​(long value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.CharSequence></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.CharSequence)">of</a></span>​(java.lang.CharSequence value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.math.BigDecimal></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.math.BigDecimal)">of</a></span>​(java.math.BigDecimal value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.nio.ByteBuffer></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.nio.ByteBuffer)">of</a></span>​(java.nio.ByteBuffer value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.util.UUID></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.util.UUID)">of</a></span>​(java.util.UUID value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><X> <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><X></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#to(org.apache.iceberg.types.Type)">to</a></span>​(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this literal to a literal of the given type.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>default java.nio.ByteBuffer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toByteBuffer()">toByteBuffer</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Serializes the value wrapped by this literal to binary using the single-value serialization |
| format described in the Iceberg table specification.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="Literal.html" title="type parameter in Literal">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#value()">value</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the value wrapped by this literal.</div> |
| </td> |
| </tr> |
| </table> |
| </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(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Boolean> of​(boolean value)</pre> |
| </li> |
| </ul> |
| <a id="of(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Integer> of​(int value)</pre> |
| </li> |
| </ul> |
| <a id="of(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Long> of​(long value)</pre> |
| </li> |
| </ul> |
| <a id="of(float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Float> of​(float value)</pre> |
| </li> |
| </ul> |
| <a id="of(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.Double> of​(double value)</pre> |
| </li> |
| </ul> |
| <a id="of(java.lang.CharSequence)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.lang.CharSequence> of​(java.lang.CharSequence value)</pre> |
| </li> |
| </ul> |
| <a id="of(java.util.UUID)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.util.UUID> of​(java.util.UUID value)</pre> |
| </li> |
| </ul> |
| <a id="of(byte[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.nio.ByteBuffer> of​(byte[] value)</pre> |
| </li> |
| </ul> |
| <a id="of(java.nio.ByteBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.nio.ByteBuffer> of​(java.nio.ByteBuffer value)</pre> |
| </li> |
| </ul> |
| <a id="of(java.math.BigDecimal)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>of</h4> |
| <pre class="methodSignature">static <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><java.math.BigDecimal> of​(java.math.BigDecimal value)</pre> |
| </li> |
| </ul> |
| <a id="value()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre class="methodSignature"><a href="Literal.html" title="type parameter in Literal">T</a> value()</pre> |
| <div class="block">Returns the value wrapped by this literal.</div> |
| </li> |
| </ul> |
| <a id="to(org.apache.iceberg.types.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre class="methodSignature"><X> <a href="Literal.html" title="interface in org.apache.iceberg.expressions">Literal</a><X> to​(<a href="../types/Type.html" title="interface in org.apache.iceberg.types">Type</a> type)</pre> |
| <div class="block">Converts this literal to a literal of the given type. |
| <p> |
| When a predicate is bound to a concrete data column, literals are converted to match the bound |
| column's type. This conversion process is more narrow than a cast and is only intended for |
| cases where substituting one type is a common mistake (e.g. 34 instead of 34L) or where this |
| API avoids requiring a concrete class (e.g., dates). |
| <p> |
| If conversion to a target type is not supported, this method returns null. |
| <p> |
| This method may return <code>Literals.aboveMax()</code> or <code>Literals.belowMin()</code> when the target |
| type is not as wide as the original type. These values indicate that the containing predicate |
| can be simplified. For example, Integer.MAX_VALUE+1 converted to an int will result in |
| <code>aboveMax</code> and can simplify a < Integer.MAX_VALUE+1 to <a href="Expressions.html#alwaysTrue()"><code>Expressions.alwaysTrue()</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>X</code> - The Java type of value the new literal contains</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - A primitive <a href="../types/Type.html" title="interface in org.apache.iceberg.types"><code>Type</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A literal of the given type or null if conversion was not valid</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="comparator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>comparator</h4> |
| <pre class="methodSignature">java.util.Comparator<<a href="Literal.html" title="type parameter in Literal">T</a>> comparator()</pre> |
| <div class="block">Return a <code>Comparator</code> for values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a comparator for T objects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toByteBuffer()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toByteBuffer</h4> |
| <pre class="methodSignature">default java.nio.ByteBuffer toByteBuffer()</pre> |
| <div class="block">Serializes the value wrapped by this literal to binary using the single-value serialization |
| format described in the Iceberg table specification.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a ByteBuffer that contains the serialized literal 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="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 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>Nested | </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> |
| </footer> |
| </body> |
| </html> |
