| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Transaction (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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="Transaction (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":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> |
| <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="class-use/Transaction.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="../../../../../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> |
| <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><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 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.qpid.protonj2.engine</a></div> |
| <h2 title="Interface Transaction" class="title">Interface Transaction<E extends <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><?>></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>E</code> - The parent of this Transaction either a <a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> or <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ProtonTransaction.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonTransaction</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Transaction<E extends <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><?>></span></pre> |
| <div class="block">A Transaction object that hold information and context for a single <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine">Transaction.DischargeState</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Provides state for this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachments()">getAttachments</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCondition()">getCondition</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If the declare or discharge of the transaction caused its state to become <a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine"><code>TransactionState</code></a> FAILED |
| this method returns the <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> that the remote used to describe the reason for the failure.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine">Transaction.DischargeState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDischargeState()">getDischargeState</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">For a <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> that has either been requested to discharge or has successfully |
| discharged the <a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine"><code>Transaction.DischargeState</code></a> reflects whether the transaction was to be committed or |
| rolled back.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource()">getLinkedResource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource(java.lang.Class)">getLinkedResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> typeClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine">TransactionState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnId()">getTxnId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the transaction Id that is associated with the declared transaction.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDeclared()">isDeclared</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isDischarged()">isDischarged</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFailed()">isFailed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The parent resource will mark the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> as failed is any of the operations performed on |
| it cannot be successfully completed such as a <a href="../types/transactions/Declare.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Declare</code></a> operation failing to write due to an IO |
| error.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="Transaction.html" title="type parameter in Transaction">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parent()">parent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a reference to the parent of this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> which will be either a |
| <a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> or a <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a> manager depending on the |
| end of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> that is operating on the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLinkedResource(java.lang.Object)">setLinkedResource</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Links a given resource to this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</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="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre class="methodSignature"><a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine">TransactionState</a> getState()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDischargeState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDischargeState</h4> |
| <pre class="methodSignature"><a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine">Transaction.DischargeState</a> getDischargeState()</pre> |
| <div class="block">For a <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> that has either been requested to discharge or has successfully |
| discharged the <a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine"><code>Transaction.DischargeState</code></a> reflects whether the transaction was to be committed or |
| rolled back. Prior to a discharge being attempted there is no state value and this method |
| returns a <a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine"><code>Transaction.DischargeState</code></a> of none.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current <a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine"><code>Transaction.DischargeState</code></a> of the transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDeclared()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDeclared</h4> |
| <pre class="methodSignature">boolean isDeclared()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> has been marked declared by the <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isDischarged()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDischarged</h4> |
| <pre class="methodSignature">boolean isDischarged()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> has been marked discharged by the <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFailed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFailed</h4> |
| <pre class="methodSignature">boolean isFailed()</pre> |
| <div class="block">The parent resource will mark the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> as failed is any of the operations performed on |
| it cannot be successfully completed such as a <a href="../types/transactions/Declare.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Declare</code></a> operation failing to write due to an IO |
| error.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> has been marked failed by the parent resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCondition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCondition</h4> |
| <pre class="methodSignature"><a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> getCondition()</pre> |
| <div class="block">If the declare or discharge of the transaction caused its state to become <a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine"><code>TransactionState</code></a> FAILED |
| this method returns the <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> that the remote used to describe the reason for the failure.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> that the <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a> used to fail the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parent</h4> |
| <pre class="methodSignature"><a href="Transaction.html" title="type parameter in Transaction">E</a> parent()</pre> |
| <div class="block">Returns a reference to the parent of this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> which will be either a |
| <a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> or a <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a> manager depending on the |
| end of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> that is operating on the <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a reference to the parent of this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTxnId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTxnId</h4> |
| <pre class="methodSignature"><a href="../types/Binary.html" title="class in org.apache.qpid.protonj2.types">Binary</a> getTxnId()</pre> |
| <div class="block">Returns the transaction Id that is associated with the declared transaction. Prior to a |
| <a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionManager</code></a> completing a transaction declaration this method will return |
| null to indicate that the transaction has not been declared yet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the transaction Id associated with the transaction once successfully declared.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre class="methodSignature"><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a> getAttachments()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine"><code>Attachments</code></a> instance that is associated with this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLinkedResource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkedResource</h4> |
| <pre class="methodSignature">void setLinkedResource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> resource)</pre> |
| <div class="block">Links a given resource to this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - The resource to link to this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLinkedResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> getLinkedResource()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLinkedResource(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature"><T> T getLinkedResource​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> typeClass)</pre> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the linked resource cannot be cast to the type requested.</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="class-use/Transaction.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="../../../../../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><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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |