| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_55) on Mon Sep 15 17:28:21 CEST 2014 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>StateMachine (Apache MINA 2.0.8 API)</title> |
| <meta name="date" content="2014-09-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="StateMachine (Apache MINA 2.0.8 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/StateMachine.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="../../../../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/mina/statemachine/StateControl.html" title="class in org.apache.mina.statemachine"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/statemachine/StateMachineCreationException.html" title="class in org.apache.mina.statemachine"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/statemachine/StateMachine.html" target="_top">Frames</a></li> |
| <li><a href="StateMachine.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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.mina.statemachine</div> |
| <h2 title="Class StateMachine" class="title">Class StateMachine</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.statemachine.StateMachine</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">StateMachine</span> |
| extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Represents a complete state machine. Contains a collection of <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> |
| objects connected by <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a>s. Normally you wouldn't create |
| instances of this class directly but rather use the |
| <a href="../../../../org/apache/mina/statemachine/annotation/State.html" title="annotation in org.apache.mina.statemachine.annotation"><code>State</code></a> annotation to define |
| your states and then let <a href="../../../../org/apache/mina/statemachine/StateMachineFactory.html" title="class in org.apache.mina.statemachine"><code>StateMachineFactory</code></a> create a |
| <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a> for you.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/mina/statemachine/StateMachine.html#StateMachine(java.util.Collection, java.lang.String)">StateMachine</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>> states, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> startStateId)</code> |
| <div class="block">Creates a new instance using the specified <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s and start |
| state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/mina/statemachine/StateMachine.html#StateMachine(org.apache.mina.statemachine.State[], java.lang.String)">StateMachine</a></strong>(<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>[] states, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> startStateId)</code> |
| <div class="block">Creates a new instance using the specified <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s and start |
| state.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/statemachine/StateMachine.html#getState(java.lang.String)">getState</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id)</code> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/statemachine/StateMachine.html#getStates()">getStates</a></strong>()</code> |
| <div class="block">Returns an unmodifiable <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> of all <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s used by |
| this <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/mina/statemachine/StateMachine.html#handle(org.apache.mina.statemachine.event.Event)">handle</a></strong>(<a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event">Event</a> event)</code> |
| <div class="block">Processes the specified <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a> through this <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StateMachine(org.apache.mina.statemachine.State[], java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>StateMachine</h4> |
| <pre>public StateMachine(<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>[] states, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> startStateId)</pre> |
| <div class="block">Creates a new instance using the specified <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s and start |
| state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>states</code> - the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s.</dd><dd><code>startStateId</code> - the id of the start <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>.</dd></dl> |
| </li> |
| </ul> |
| <a name="StateMachine(java.util.Collection, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StateMachine</h4> |
| <pre>public StateMachine(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>> states, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> startStateId)</pre> |
| <div class="block">Creates a new instance using the specified <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s and start |
| state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>states</code> - the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s.</dd><dd><code>startStateId</code> - the id of the start <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getState(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>public <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a> getState(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id) |
| throws <a href="../../../../org/apache/mina/statemachine/NoSuchStateException.html" title="class in org.apache.mina.statemachine">NoSuchStateException</a></pre> |
| <div class="block">Returns the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - the id of the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> to return.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/statemachine/NoSuchStateException.html" title="class in org.apache.mina.statemachine">NoSuchStateException</a></code> - if no matching <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> could be found.</dd></dl> |
| </li> |
| </ul> |
| <a name="getStates()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStates</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine">State</a>> getStates()</pre> |
| <div class="block">Returns an unmodifiable <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> of all <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s used by |
| this <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a>.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>s.</dd></dl> |
| </li> |
| </ul> |
| <a name="handle(org.apache.mina.statemachine.event.Event)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>handle</h4> |
| <pre>public void handle(<a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event">Event</a> event)</pre> |
| <div class="block">Processes the specified <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a> through this <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a>. |
| Normally you wouldn't call this directly but rather use |
| <a href="../../../../org/apache/mina/statemachine/StateMachineProxyBuilder.html" title="class in org.apache.mina.statemachine"><code>StateMachineProxyBuilder</code></a> to create a proxy for an interface of |
| your choice. Any method calls on the proxy will be translated into |
| <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a> objects and then fed to the <a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><code>StateMachine</code></a> by the |
| proxy using this method.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - the <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a> to be handled.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/StateMachine.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="../../../../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/mina/statemachine/StateControl.html" title="class in org.apache.mina.statemachine"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/statemachine/StateMachineCreationException.html" title="class in org.apache.mina.statemachine"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/statemachine/StateMachine.html" target="_top">Frames</a></li> |
| <li><a href="StateMachine.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><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2014 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |