| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Keyable</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="Keyable"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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><a href="../../../../org/apache/openejb/jee/JspPropertyGroup$JAXB.html" title="class in org.apache.openejb.jee"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/jee/KeyedCollection.html" title="class in org.apache.openejb.jee"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/jee/Keyable.html" target="_top">Frames</a></li> |
| <li><a href="Keyable.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>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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.openejb.jee</div> |
| <h2 title="Interface Keyable" class="title">Interface Keyable<K></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/openejb/jee/EjbReference.html" title="interface in org.apache.openejb.jee">EjbReference</a>, <a href="../../../../org/apache/openejb/jee/jpa/Field.html" title="interface in org.apache.openejb.jee.jpa">Field</a>, <a href="../../../../org/apache/openejb/jee/JndiReference.html" title="interface in org.apache.openejb.jee">JndiReference</a>, <a href="../../../../org/apache/openejb/jee/PersistenceRef.html" title="interface in org.apache.openejb.jee">PersistenceRef</a>, <a href="../../../../org/apache/openejb/jee/jpa/RelationField.html" title="interface in org.apache.openejb.jee.jpa">RelationField</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openejb/jee/ApplicationException.html" title="class in org.apache.openejb.jee">ApplicationException</a>, <a href="../../../../org/apache/openejb/jee/jpa/AttributeOverride.html" title="class in org.apache.openejb.jee.jpa">AttributeOverride</a>, <a href="../../../../org/apache/openejb/jee/jpa/Basic.html" title="class in org.apache.openejb.jee.jpa">Basic</a>, <a href="../../../../org/apache/openejb/config/ContextRef.html" title="class in org.apache.openejb.config">ContextRef</a>, <a href="../../../../org/apache/openejb/jee/DataSource.html" title="class in org.apache.openejb.jee">DataSource</a>, <a href="../../../../org/apache/openejb/jee/EjbLocalRef.html" title="class in org.apache.openejb.jee">EjbLocalRef</a>, <a href="../../../../org/apache/openejb/jee/EjbRef.html" title="class in org.apache.openejb.jee">EjbRef</a>, <a href="../../../../org/apache/openejb/jee/jpa/Entity.html" title="class in org.apache.openejb.jee.jpa">Entity</a>, <a href="../../../../org/apache/openejb/jee/EnvEntry.html" title="class in org.apache.openejb.jee">EnvEntry</a>, <a href="../../../../org/apache/openejb/jee/ExceptionMapping.html" title="class in org.apache.openejb.jee">ExceptionMapping</a>, <a href="../../../../org/apache/openejb/jee/Icon.html" title="class in org.apache.openejb.jee">Icon</a>, <a href="../../../../org/apache/openejb/jee/jpa/Id.html" title="class in org.apache.openejb.jee.jpa">Id</a>, <a href="../../../../org/apache/openejb/jee/JMSConnectionFactory.html" title="class in org.apache.openejb.jee">JMSConnectionFactory</a>, <a href="../../../../org/apache/openejb/jee/JMSDestination.html" title="class in org.apache.openejb.jee">JMSDestination</a>, <a href="../../../../org/apache/openejb/jee/jpa/ManyToMany.html" title="class in org.apache.openejb.jee.jpa">ManyToMany</a>, <a href="../../../../org/apache/openejb/jee/jpa/ManyToOne.html" title="class in org.apache.openejb.jee.jpa">ManyToOne</a>, <a href="../../../../org/apache/openejb/jee/jpa/MappedSuperclass.html" title="class in org.apache.openejb.jee.jpa">MappedSuperclass</a>, <a href="../../../../org/apache/openejb/jee/MessageDestination.html" title="class in org.apache.openejb.jee">MessageDestination</a>, <a href="../../../../org/apache/openejb/jee/MessageDestinationRef.html" title="class in org.apache.openejb.jee">MessageDestinationRef</a>, <a href="../../../../org/apache/openejb/jee/jpa/OneToMany.html" title="class in org.apache.openejb.jee.jpa">OneToMany</a>, <a href="../../../../org/apache/openejb/jee/jpa/OneToOne.html" title="class in org.apache.openejb.jee.jpa">OneToOne</a>, <a href="../../../../org/apache/openejb/jee/PackageMapping.html" title="class in org.apache.openejb.jee">PackageMapping</a>, <a href="../../../../org/apache/openejb/jee/PersistenceContextRef.html" title="class in org.apache.openejb.jee">PersistenceContextRef</a>, <a href="../../../../org/apache/openejb/jee/PersistenceUnitRef.html" title="class in org.apache.openejb.jee">PersistenceUnitRef</a>, <a href="../../../../org/apache/openejb/jee/PortComponent.html" title="class in org.apache.openejb.jee">PortComponent</a>, <a href="../../../../org/apache/openejb/jee/ResourceEnvRef.html" title="class in org.apache.openejb.jee">ResourceEnvRef</a>, <a href="../../../../org/apache/openejb/jee/ResourceRef.html" title="class in org.apache.openejb.jee">ResourceRef</a>, <a href="../../../../org/apache/openejb/jee/ServiceEndpointInterfaceMapping.html" title="class in org.apache.openejb.jee">ServiceEndpointInterfaceMapping</a>, <a href="../../../../org/apache/openejb/jee/ServiceRef.html" title="class in org.apache.openejb.jee">ServiceRef</a>, <a href="../../../../org/apache/openejb/jee/jpa/Transient.html" title="class in org.apache.openejb.jee.jpa">Transient</a>, <a href="../../../../org/apache/openejb/jee/WebserviceDescription.html" title="class in org.apache.openejb.jee">WebserviceDescription</a>, <a href="../../../../org/apache/openejb/jee/sun/WebserviceDescription.html" title="class in org.apache.openejb.jee.sun">WebserviceDescription</a>, <a href="../../../../org/apache/openejb/jee/sun/WebserviceEndpoint.html" title="class in org.apache.openejb.jee.sun">WebserviceEndpoint</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Keyable<K></span></pre> |
| <div class="block">A keyable object can provide an immutable key for this object. |
| |
| It is important for the key to not be mutable and that the key value |
| itself is not changed in the object. If this happens any AutoIndex, |
| or Map using this key will break.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="../../../../org/apache/openejb/jee/Keyable.html" title="type parameter in Keyable">K</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/jee/Keyable.html#getKey--">getKey</a></span>()</code> |
| <div class="block">Gets the immutable key for this object.</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="getKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getKey</h4> |
| <pre><a href="../../../../org/apache/openejb/jee/Keyable.html" title="type parameter in Keyable">K</a> getKey()</pre> |
| <div class="block">Gets the immutable key for this object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>gets the immutable key for this object</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="../../../../org/apache/openejb/jee/JspPropertyGroup$JAXB.html" title="class in org.apache.openejb.jee"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/jee/KeyedCollection.html" title="class in org.apache.openejb.jee"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/jee/Keyable.html" target="_top">Frames</a></li> |
| <li><a href="Keyable.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>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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
