| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>TransactionPhase</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="TransactionPhase"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../jakarta/enterprise/event/Startup.html" title="class in jakarta.enterprise.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/enterprise/event/TransactionPhase.html" target="_top">Frames</a></li> |
| <li><a href="TransactionPhase.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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.enterprise.event</div> |
| <h2 title="Enum TransactionPhase" class="title">Enum TransactionPhase</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Enum<<a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.enterprise.event.TransactionPhase</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, java.lang.Comparable<<a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">TransactionPhase</span> |
| extends java.lang.Enum<<a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a>></pre> |
| <div class="block"><p> |
| Distinguishes the various kinds of transactional <a href="../../../jakarta/enterprise/event/Observes.html" title="annotation in jakarta.enterprise.event">observer methods</a> from regular |
| observer methods which are notified immediately. |
| </p> |
| <p> |
| Transactional observer methods are observer methods which receive event notifications during the before or after completion |
| phase of the transaction in which the event was fired. If no transaction is in progress when the event is fired, they are |
| notified at the same time as other observers. |
| If the transaction is in progress, but <code>jakarta.transaction.Synchronization</code> callback cannot be registered due to the transaction being already |
| marked for rollback or in state where <code>jakarta.transaction.Synchronization</code> callbacks cannot be registered, the <a href="../../../jakarta/enterprise/event/TransactionPhase.html#BEFORE_COMPLETION"><code>BEFORE_COMPLETION</code></a>, |
| <a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_COMPLETION"><code>AFTER_COMPLETION</code></a> and <a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_FAILURE"><code>AFTER_FAILURE</code></a> observer methods are notified at the same time as other observers, |
| but <a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_SUCCESS"><code>AFTER_SUCCESS</code></a> observer methods get skipped. |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_COMPLETION">AFTER_COMPLETION</a></span></code> |
| <div class="block"> |
| Identifies an after completion observer method, called during the after completion phase of the transaction.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_FAILURE">AFTER_FAILURE</a></span></code> |
| <div class="block"> |
| Identifies an after failure observer method, called during the after completion phase of the transaction, only when the |
| transaction fails.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#AFTER_SUCCESS">AFTER_SUCCESS</a></span></code> |
| <div class="block"> |
| Identifies an after success observer method, called during the after completion phase of the transaction, only when the |
| transaction completes successfully.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#BEFORE_COMPLETION">BEFORE_COMPLETION</a></span></code> |
| <div class="block"> |
| Identifies a before completion observer method, called during the before completion phase of the transaction.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#IN_PROGRESS">IN_PROGRESS</a></span></code> |
| <div class="block"> |
| Identifies a regular observer method, called when the event is fired.</div> |
| </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/enterprise/event/TransactionPhase.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Enum</h3> |
| <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="IN_PROGRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>IN_PROGRESS</h4> |
| <pre>public static final <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> IN_PROGRESS</pre> |
| <div class="block"><p> |
| Identifies a regular observer method, called when the event is fired. |
| </p></div> |
| </li> |
| </ul> |
| <a name="BEFORE_COMPLETION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BEFORE_COMPLETION</h4> |
| <pre>public static final <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> BEFORE_COMPLETION</pre> |
| <div class="block"><p> |
| Identifies a before completion observer method, called during the before completion phase of the transaction. |
| </p> |
| <p> |
| Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, |
| but <code>jakarta.transaction.Synchronization</code> callback cannot be registered due to the transaction being already |
| marked for rollback or in state where <code>jakarta.transaction.Synchronization</code> callbacks cannot be registered. |
| </p></div> |
| </li> |
| </ul> |
| <a name="AFTER_COMPLETION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AFTER_COMPLETION</h4> |
| <pre>public static final <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> AFTER_COMPLETION</pre> |
| <div class="block"><p> |
| Identifies an after completion observer method, called during the after completion phase of the transaction. |
| </p> |
| <p> |
| Transactional observer will be notified if there is no transaction in progress, or the transaction is in progress, |
| but <code>jakarta.transaction.Synchronization</code> callback cannot be registered due to the transaction being already |
| marked for rollback or in state where <code>jakarta.transaction.Synchronization</code> callbacks cannot be registered. |
| </p></div> |
| </li> |
| </ul> |
| <a name="AFTER_FAILURE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AFTER_FAILURE</h4> |
| <pre>public static final <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> AFTER_FAILURE</pre> |
| <div class="block"><p> |
| Identifies an after failure observer method, called during the after completion phase of the transaction, only when the |
| transaction fails. |
| </p> |
| <p> |
| Transactional observer will be notified will also get invoked if there is no transaction in progress, or the transaction is in progress, |
| but <code>jakarta.transaction.Synchronization</code> callback cannot be registered due to the transaction being already |
| marked for rollback or in state where <code>jakarta.transaction.Synchronization</code> callbacks cannot be registered. |
| </p></div> |
| </li> |
| </ul> |
| <a name="AFTER_SUCCESS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AFTER_SUCCESS</h4> |
| <pre>public static final <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> AFTER_SUCCESS</pre> |
| <div class="block"><p> |
| Identifies an after success observer method, called during the after completion phase of the transaction, only when the |
| transaction completes successfully. |
| </p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (TransactionPhase c : TransactionPhase.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../jakarta/enterprise/event/TransactionPhase.html" title="enum in jakarta.enterprise.event">TransactionPhase</a> valueOf(java.lang.String name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> |
| <dd><code>java.lang.NullPointerException</code> - if the argument is null</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/enterprise/event/Startup.html" title="class in jakarta.enterprise.event"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/enterprise/event/TransactionPhase.html" target="_top">Frames</a></li> |
| <li><a href="TransactionPhase.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
