| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Attribute</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="Attribute"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../jakarta/persistence/metamodel/Attribute.PersistentAttributeType.html" title="enum in jakarta.persistence.metamodel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/persistence/metamodel/Attribute.html" target="_top">Frames</a></li> |
| <li><a href="Attribute.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.class.summary">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">jakarta.persistence.metamodel</div> |
| <h2 title="Interface Attribute" class="title">Interface Attribute<X,Y></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>X</code> - The represented type that contains the attribute</dd> |
| <dd><code>Y</code> - The type of the represented attribute</dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../jakarta/persistence/metamodel/CollectionAttribute.html" title="interface in jakarta.persistence.metamodel">CollectionAttribute</a><X,E>, <a href="../../../jakarta/persistence/metamodel/ListAttribute.html" title="interface in jakarta.persistence.metamodel">ListAttribute</a><X,E>, <a href="../../../jakarta/persistence/metamodel/MapAttribute.html" title="interface in jakarta.persistence.metamodel">MapAttribute</a><X,K,V>, <a href="../../../jakarta/persistence/metamodel/PluralAttribute.html" title="interface in jakarta.persistence.metamodel">PluralAttribute</a><X,C,E>, <a href="../../../jakarta/persistence/metamodel/SetAttribute.html" title="interface in jakarta.persistence.metamodel">SetAttribute</a><X,E>, <a href="../../../jakarta/persistence/metamodel/SingularAttribute.html" title="interface in jakarta.persistence.metamodel">SingularAttribute</a><X,T></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Attribute<X,Y></span></pre> |
| <div class="block">Represents an attribute of a Java type.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.PersistentAttributeType.html" title="enum in jakarta.persistence.metamodel">Attribute.PersistentAttributeType</a></span></code> </td> |
| </tr> |
| </table> |
| </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="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></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="../../../jakarta/persistence/metamodel/ManagedType.html" title="interface in jakarta.persistence.metamodel">ManagedType</a><<a href="../../../jakarta/persistence/metamodel/Attribute.html" title="type parameter in Attribute">X</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#getDeclaringType--">getDeclaringType</a></span>()</code> |
| <div class="block">Return the managed type representing the type in which |
| the attribute was declared.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.reflect.Member</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#getJavaMember--">getJavaMember</a></span>()</code> |
| <div class="block">Return the <code>java.lang.reflect.Member</code> for the represented |
| attribute.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.Class<<a href="../../../jakarta/persistence/metamodel/Attribute.html" title="type parameter in Attribute">Y</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#getJavaType--">getJavaType</a></span>()</code> |
| <div class="block">Return the Java type of the represented attribute.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#getName--">getName</a></span>()</code> |
| <div class="block">Return the name of the attribute.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/persistence/metamodel/Attribute.PersistentAttributeType.html" title="enum in jakarta.persistence.metamodel">Attribute.PersistentAttributeType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#getPersistentAttributeType--">getPersistentAttributeType</a></span>()</code> |
| <div class="block">Return the persistent attribute type for the attribute.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#isAssociation--">isAssociation</a></span>()</code> |
| <div class="block">Is the attribute an association.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/persistence/metamodel/Attribute.html#isCollection--">isCollection</a></span>()</code> |
| <div class="block">Is the attribute collection-valued (represents a Collection, |
| Set, List, or Map).</div> |
| </td> |
| </tr> |
| </table> |
| </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="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block">Return the name of the attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPersistentAttributeType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPersistentAttributeType</h4> |
| <pre><a href="../../../jakarta/persistence/metamodel/Attribute.PersistentAttributeType.html" title="enum in jakarta.persistence.metamodel">Attribute.PersistentAttributeType</a> getPersistentAttributeType()</pre> |
| <div class="block">Return the persistent attribute type for the attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>persistent attribute type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeclaringType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeclaringType</h4> |
| <pre><a href="../../../jakarta/persistence/metamodel/ManagedType.html" title="interface in jakarta.persistence.metamodel">ManagedType</a><<a href="../../../jakarta/persistence/metamodel/Attribute.html" title="type parameter in Attribute">X</a>> getDeclaringType()</pre> |
| <div class="block">Return the managed type representing the type in which |
| the attribute was declared.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>declaring type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJavaType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaType</h4> |
| <pre>java.lang.Class<<a href="../../../jakarta/persistence/metamodel/Attribute.html" title="type parameter in Attribute">Y</a>> getJavaType()</pre> |
| <div class="block">Return the Java type of the represented attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Java type</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJavaMember--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJavaMember</h4> |
| <pre>java.lang.reflect.Member getJavaMember()</pre> |
| <div class="block">Return the <code>java.lang.reflect.Member</code> for the represented |
| attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>corresponding <code>java.lang.reflect.Member</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isAssociation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAssociation</h4> |
| <pre>boolean isAssociation()</pre> |
| <div class="block">Is the attribute an association.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean indicating whether the attribute |
| corresponds to an association</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCollection--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isCollection</h4> |
| <pre>boolean isCollection()</pre> |
| <div class="block">Is the attribute collection-valued (represents a Collection, |
| Set, List, or Map).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean indicating whether the attribute is |
| collection-valued</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>Prev Class</li> |
| <li><a href="../../../jakarta/persistence/metamodel/Attribute.PersistentAttributeType.html" title="enum in jakarta.persistence.metamodel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/persistence/metamodel/Attribute.html" target="_top">Frames</a></li> |
| <li><a href="Attribute.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.class.summary">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 ======= --> |
| </body> |
| </html> |