Google Git
Sign in
apache / tomee-site-pub / d971bdc415a5aacedad7a73bfc59a72abe0ddc09 / . / jakartaee-9.0 / javadoc / jakarta / persistence / Entity.html
blob: e8ca79bde742473fec532a6bcffa30dc2e257d32 [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>
<title>Entity</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Entity";
}
}
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>
<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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/persistence/EmbeddedId.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/persistence/EntityExistsException.html" title="class in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/persistence/Entity.html" target="_top">Frames</a></li>
<li><a href="Entity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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">jakarta.persistence</div>
<h2 title="Annotation Type Entity" class="title">Annotation Type Entity</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Documented
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface <span class="memberNameLabel">Entity</span></pre>
<div class="block">Specifies that the class is an entity. This annotation is applied to the
entity class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="simpleTagLabel">Examples (en):</span></dt>
<dd><a href="../../../../../tomee-9.0/examples/xa-datasource.html">xa-datasource</a>, <a href="../../../../../tomee-9.0/examples/webservice-inheritance.html">webservice-inheritance</a>, <a href="../../../../../tomee-9.0/examples/troubleshooting.html">troubleshooting</a>, <a href="../../../../../tomee-9.0/examples/transaction-rollback.html">transaction-rollback</a>, <a href="../../../../../tomee-9.0/examples/tomee-jersey-eclipselink.html">tomee-jersey-eclipselink</a>, <a href="../../../../../tomee-9.0/examples/testing-transactions.html">testing-transactions</a>, <a href="../../../../../tomee-9.0/examples/testing-transactions-bmt.html">testing-transactions-bmt</a>, <a href="../../../../../tomee-9.0/examples/testing-security.html">testing-security</a>, <a href="../../../../../tomee-9.0/examples/testing-security-meta.html">testing-security-meta</a>, <a href="../../../../../tomee-9.0/examples/testing-security-4.html">testing-security-4</a>, <a href="../../../../../tomee-9.0/examples/testing-security-3.html">testing-security-3</a>, <a href="../../../../../tomee-9.0/examples/testing-security-2.html">testing-security-2</a>, <a href="../../../../../tomee-9.0/examples/testcase-injection.html">testcase-injection</a>, <a href="../../../../../tomee-9.0/examples/struts.txt">struts</a>, <a href="../../../../../tomee-9.0/examples/spring-data-proxy.html">spring-data-proxy</a>, <a href="../../../../../tomee-9.0/examples/spring-data-proxy-meta.html">spring-data-proxy-meta</a>, <a href="../../../../../tomee-9.0/examples/rest-on-ejb.html">rest-on-ejb</a>, <a href="../../../../../tomee-9.0/examples/rest-example.html">rest-example</a>, <a href="../../../../../tomee-9.0/examples/reload-persistence-unit-properties.html">reload-persistence-unit-properties</a>, <a href="../../../../../tomee-9.0/examples/polling-parent.html">polling-parent</a>, <a href="../../../../../tomee-9.0/examples/persistence-fragment.html">persistence-fragment</a>, <a href="../../../../../tomee-9.0/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-9.0/examples/mvc-cxf.html">mvc-cxf</a>, <a href="../../../../../tomee-9.0/examples/mvc-cxf-hibernate.html">mvc-cxf-hibernate</a>, <a href="../../../../../tomee-9.0/examples/multi-jpa-provider-testing.html">multi-jpa-provider-testing</a>, <a href="../../../../../tomee-9.0/examples/movies-complete.html">movies-complete</a>, <a href="../../../../../tomee-9.0/examples/movies-complete-meta.html">movies-complete-meta</a>, <a href="../../../../../tomee-9.0/examples/moviefun.html">moviefun</a>, <a href="../../../../../tomee-9.0/examples/moviefun-rest.html">moviefun-rest</a>, <a href="../../../../../tomee-9.0/examples/jpa-hibernate.html">jpa-hibernate</a>, <a href="../../../../../tomee-9.0/examples/jpa-enumerated.html">jpa-enumerated</a>, <a href="../../../../../tomee-9.0/examples/jpa-eclipselink.html">jpa-eclipselink</a>, <a href="../../../../../tomee-9.0/examples/injection-of-entitymanager.html">injection-of-entitymanager</a>, <a href="../../../../../tomee-9.0/examples/groovy-jpa.html">groovy-jpa</a>, <a href="../../../../../tomee-9.0/examples/ejb-examples.html">ejb-examples</a>, <a href="../../../../../tomee-9.0/examples/ear-testing.html">ear-testing</a>, <a href="../../../../../tomee-9.0/examples/dynamic-datasource-routing.html">dynamic-datasource-routing</a>, <a href="../../../../../tomee-9.0/examples/dynamic-dao-implementation.html">dynamic-dao-implementation</a>, <a href="../../../../../tomee-9.0/examples/deltaspike-fullstack.html">deltaspike-fullstack</a>, <a href="../../../../../tomee-9.0/examples/connector-war.html">connector-war</a>, <a href="../../../../../tomee-9.0/examples/arquillian-jpa.html">arquillian-jpa</a>, <a href="../../../../../tomee-9.0/examples/application-composer.html">application-composer</a>, <a href="../../../../../tomee-9.0/examples/alternate-descriptors.html">alternate-descriptors</a></dd>
<dt><span class="simpleTagLabel">Examples (es):</span></dt>
<dd><a href="../../../../../tomee-9.0/es/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-9.0/es/examples/jpa-hibernate.html">jpa-hibernate</a>, <a href="../../../../../tomee-9.0/es/examples/groovy-jpa.html">groovy-jpa</a>, <a href="../../../../../tomee-9.0/es/examples/arquillian-jpa.html">arquillian-jpa</a>, <a href="../../../../../tomee-9.0/es/examples/alternate-descriptors.html">alternate-descriptors</a></dd>
<dt><span class="simpleTagLabel">Examples (pt):</span></dt>
<dd><a href="../../../../../tomee-9.0/pt/examples/xa-datasource.html">xa-datasource</a>, <a href="../../../../../tomee-9.0/pt/examples/testing-security.html">testing-security</a>, <a href="../../../../../tomee-9.0/pt/examples/spring-data-proxy.html">spring-data-proxy</a>, <a href="../../../../../tomee-9.0/pt/examples/spring-data-proxy-meta.html">spring-data-proxy-meta</a>, <a href="../../../../../tomee-9.0/pt/examples/persistence-fragment.html">persistence-fragment</a>, <a href="../../../../../tomee-9.0/pt/examples/myfaces-codi-demo.html">myfaces-codi-demo</a>, <a href="../../../../../tomee-9.0/pt/examples/mvc-cxf-hibernate.html">mvc-cxf-hibernate</a>, <a href="../../../../../tomee-9.0/pt/examples/multi-jpa-provider-testing.html">multi-jpa-provider-testing</a>, <a href="../../../../../tomee-9.0/pt/examples/moviefun-rest.html">moviefun-rest</a>, <a href="../../../../../tomee-9.0/pt/examples/jpa-hibernate.html">jpa-hibernate</a>, <a href="../../../../../tomee-9.0/pt/examples/jpa-enumerated.html">jpa-enumerated</a>, <a href="../../../../../tomee-9.0/pt/examples/jpa-eclipselink.html">jpa-eclipselink</a>, <a href="../../../../../tomee-9.0/pt/examples/injection-of-entitymanager.html">injection-of-entitymanager</a>, <a href="../../../../../tomee-9.0/pt/examples/groovy-jpa.html">groovy-jpa</a>, <a href="../../../../../tomee-9.0/pt/examples/ear-testing.html">ear-testing</a>, <a href="../../../../../tomee-9.0/pt/examples/dynamic-datasource-routing.html">dynamic-datasource-routing</a>, <a href="../../../../../tomee-9.0/pt/examples/dynamic-dao-implementation.html">dynamic-dao-implementation</a>, <a href="../../../../../tomee-9.0/pt/examples/deltaspike-fullstack.html">deltaspike-fullstack</a>, <a href="../../../../../tomee-9.0/pt/examples/arquillian-jpa.html">arquillian-jpa</a>, <a href="../../../../../tomee-9.0/pt/examples/application-composer.html">application-composer</a>, <a href="../../../../../tomee-9.0/pt/examples/alternate-descriptors.html">alternate-descriptors</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/persistence/Entity.html#name--">name</a></span></code>
<div class="block">(Optional) The entity name.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="name--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>name</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
<div class="block">(Optional) The entity name. Defaults to the unqualified
name of the entity class. This name is used to refer to the
entity in queries. The name must not be a reserved literal
in the Jakarta Persistence query language.</div>
<dl>
<dt>Default:</dt>
<dd>""</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>
<div class="subNav">
<ul class="navList">
<li><a href="../../jakarta/persistence/EmbeddedId.html" title="annotation in jakarta.persistence"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/persistence/EntityExistsException.html" title="class in jakarta.persistence"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/persistence/Entity.html" target="_top">Frames</a></li>
<li><a href="Entity.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>