blob: c26c0e052ea4d2c97317ee2fde502573f0c5af3c [file] [log] [blame]
<!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 (version 1.7.0_121) on Fri Jan 06 19:36:28 UTC 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Literal (OpenJPA Parent POM 2.4.2 API)</title>
<meta name="date" content="2017-01-06">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Literal (OpenJPA Parent POM 2.4.2 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/Literal.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">
<li><a href="../../../../../org/apache/openjpa/kernel/exps/InMemoryExpressionFactory.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/NullIf.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/Literal.html" target="_top">Frames</a></li>
<li><a href="Literal.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.openjpa.kernel.exps</div>
<h2 title="Interface Literal" class="title">Interface Literal</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps">Constant</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/Lit.html" title="class in org.apache.openjpa.jdbc.kernel.exps">Lit</a>, <a href="../../../../../org/apache/openjpa/jdbc/kernel/exps/TypeLit.html" title="class in org.apache.openjpa.jdbc.kernel.exps">TypeLit</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Literal</span>
extends <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps">Constant</a></pre>
<div class="block">Interface for any literal value.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_BOOLEAN">TYPE_BOOLEAN</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_CLASS">TYPE_CLASS</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_COLLECTION">TYPE_COLLECTION</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_DATE">TYPE_DATE</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_ENUM">TYPE_ENUM</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_NUMBER">TYPE_NUMBER</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_SQ_STRING">TYPE_SQ_STRING</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_STRING">TYPE_STRING</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_TIME">TYPE_TIME</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_TIMESTAMP">TYPE_TIMESTAMP</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#TYPE_UNKNOWN">TYPE_UNKNOWN</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#getParseType()">getParseType</a></strong>()</code>
<div class="block">The type the literal was parsed as.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#getValue()">getValue</a></strong>()</code>
<div class="block">The value of this literal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/openjpa/kernel/exps/Literal.html#setValue(java.lang.Object)">setValue</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">The value of this literal.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.exps.Value">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.kernel.exps.<a href="../../../../../org/apache/openjpa/kernel/exps/Value.html" title="interface in org.apache.openjpa.kernel.exps">Value</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#acceptVisit(org.apache.openjpa.kernel.exps.ExpressionVisitor)">acceptVisit</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getAlias()">getAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getMetaData()">getMetaData</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getName()">getName</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getPath()">getPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getSelectAs()">getSelectAs</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#getType()">getType</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isAggregate()">isAggregate</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isVariable()">isVariable</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#isXPath()">isXPath</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setAlias(java.lang.String)">setAlias</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setImplicitType(java.lang.Class)">setImplicitType</a>, <a href="../../../../../org/apache/openjpa/kernel/exps/Value.html#setMetaData(org.apache.openjpa.meta.ClassMetaData)">setMetaData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.openjpa.kernel.exps.Constant">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.kernel.exps.<a href="../../../../../org/apache/openjpa/kernel/exps/Constant.html" title="interface in org.apache.openjpa.kernel.exps">Constant</a></h3>
<code><a href="../../../../../org/apache/openjpa/kernel/exps/Constant.html#getValue(java.lang.Object[])">getValue</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TYPE_UNKNOWN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_UNKNOWN</h4>
<pre>static final&nbsp;int TYPE_UNKNOWN</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_UNKNOWN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_NUMBER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_NUMBER</h4>
<pre>static final&nbsp;int TYPE_NUMBER</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_NUMBER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_BOOLEAN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_BOOLEAN</h4>
<pre>static final&nbsp;int TYPE_BOOLEAN</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_BOOLEAN">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_STRING</h4>
<pre>static final&nbsp;int TYPE_STRING</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_STRING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_SQ_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_SQ_STRING</h4>
<pre>static final&nbsp;int TYPE_SQ_STRING</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_SQ_STRING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_CLASS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_CLASS</h4>
<pre>static final&nbsp;int TYPE_CLASS</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_CLASS">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_ENUM">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_ENUM</h4>
<pre>static final&nbsp;int TYPE_ENUM</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_ENUM">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_COLLECTION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_COLLECTION</h4>
<pre>static final&nbsp;int TYPE_COLLECTION</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_COLLECTION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_DATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_DATE</h4>
<pre>static final&nbsp;int TYPE_DATE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_DATE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_TIME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE_TIME</h4>
<pre>static final&nbsp;int TYPE_TIME</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_TIME">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TYPE_TIMESTAMP">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TYPE_TIMESTAMP</h4>
<pre>static final&nbsp;int TYPE_TIMESTAMP</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.openjpa.kernel.exps.Literal.TYPE_TIMESTAMP">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getValue()</pre>
<div class="block">The value of this literal.</div>
</li>
</ul>
<a name="setValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block">The value of this literal.</div>
</li>
</ul>
<a name="getParseType()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParseType</h4>
<pre>int&nbsp;getParseType()</pre>
<div class="block">The type the literal was parsed as.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/Literal.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">
<li><a href="../../../../../org/apache/openjpa/kernel/exps/InMemoryExpressionFactory.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/openjpa/kernel/exps/NullIf.html" title="class in org.apache.openjpa.kernel.exps"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openjpa/kernel/exps/Literal.html" target="_top">Frames</a></li>
<li><a href="Literal.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>