blob: 0966cbfab23165873ab8156046d99ee376087e05 [file] [log] [blame]
<!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 (1.8.0_191) on Sat Mar 16 19:25:16 CET 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StateControl (Apache MINA 2.0.0-M3 API Documentation)</title>
<meta name="date" content="2019-03-16">
<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="StateControl (Apache MINA 2.0.0-M3 API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":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="class-use/StateControl.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/State.html" title="class in org.apache.mina.statemachine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/statemachine/StateControl.html" target="_top">Frames</a></li>
<li><a href="StateControl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 StateControl" class="title">Class StateControl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.mina.statemachine.StateControl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">StateControl</span>
extends java.lang.Object</pre>
<div class="block">Allows for programmatic control of a state machines execution.
<p>
The <code>*Now()</code> family of methods move to a new <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>
immediately and let the new <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> handle the current <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
The <code>*Next()</code> family on the other hand let the new <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a>
handle the next <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a> which is generated which make these method the
programmatic equivalent of using the <a href="../../../../org/apache/mina/statemachine/annotation/Transition.html" title="annotation in org.apache.mina.statemachine.annotation"><code>Transition</code></a> annotation.
</p>
<p>
Using the <code>breakAndCall*()</code> and <code>breakAndReturn*</code> methods one
can create sub state machines which behave very much like sub routines.
When calling a state the current state (or the specified <code>returnTo</code>
state) will be pushed on a stack. When returning from a state the last pushed
state will be popped from the stack and used as the new state.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Rev: 592122 $, $Date: 2007-11-05 20:10:32 +0100 (Mon, 05 Nov 2007) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>The Apache MINA Project (dev@mina.apache.org)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#StateControl--">StateControl</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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 void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndCallNext-java.lang.String-">breakAndCallNext</a></span>(java.lang.String&nbsp;state)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndCallNext-java.lang.String-java.lang.String-">breakAndCallNext</a></span>(java.lang.String&nbsp;state,
java.lang.String&nbsp;returnTo)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndCallNow-java.lang.String-">breakAndCallNow</a></span>(java.lang.String&nbsp;state)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndCallNow-java.lang.String-java.lang.String-">breakAndCallNow</a></span>(java.lang.String&nbsp;state,
java.lang.String&nbsp;returnTo)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndContinue--">breakAndContinue</a></span>()</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and tries to
find another <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> with higher weight or a <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a>
of a parent <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> which can handle the current <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndGotoNext-java.lang.String-">breakAndGotoNext</a></span>(java.lang.String&nbsp;state)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndGotoNow-java.lang.String-">breakAndGotoNow</a></span>(java.lang.String&nbsp;state)</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNext--">breakAndReturnNext</a></span>()</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
last recorded <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNow--">breakAndReturnNow</a></span>()</code>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
last recorded <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="StateControl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StateControl</h4>
<pre>public&nbsp;StateControl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="breakAndContinue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndContinue</h4>
<pre>public static&nbsp;void&nbsp;breakAndContinue()</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and tries to
find another <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> with higher weight or a <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a>
of a parent <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> which can handle the current <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</li>
</ul>
<a name="breakAndGotoNow-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndGotoNow</h4>
<pre>public static&nbsp;void&nbsp;breakAndGotoNow(java.lang.String&nbsp;state)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 go to.</dd>
</dl>
</li>
</ul>
<a name="breakAndGotoNext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndGotoNext</h4>
<pre>public static&nbsp;void&nbsp;breakAndGotoNext(java.lang.String&nbsp;state)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
Using this method is the programmatic equivalent of using the
<a href="../../../../org/apache/mina/statemachine/annotation/Transition.html" title="annotation in org.apache.mina.statemachine.annotation"><code>Transition</code></a> annotation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 go to.</dd>
</dl>
</li>
</ul>
<a name="breakAndCallNow-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndCallNow</h4>
<pre>public static&nbsp;void&nbsp;breakAndCallNow(java.lang.String&nbsp;state)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
Before moving to the new state the current state will be recorded. The
next call to <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNow--"><code>breakAndReturnNow()</code></a> or <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNext--"><code>breakAndReturnNext()</code></a>
will return to the current state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 call.</dd>
</dl>
</li>
</ul>
<a name="breakAndCallNext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndCallNext</h4>
<pre>public static&nbsp;void&nbsp;breakAndCallNext(java.lang.String&nbsp;state)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
Before moving to the new state the current state will be recorded. The
next call to <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNow--"><code>breakAndReturnNow()</code></a> or <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNext--"><code>breakAndReturnNext()</code></a>
will return to the current state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 call.</dd>
</dl>
</li>
</ul>
<a name="breakAndCallNow-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndCallNow</h4>
<pre>public static&nbsp;void&nbsp;breakAndCallNow(java.lang.String&nbsp;state,
java.lang.String&nbsp;returnTo)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
Before moving to the new state the current state will be recorded. The
next call to <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNow--"><code>breakAndReturnNow()</code></a> or <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNext--"><code>breakAndReturnNext()</code></a>
will return to the specified <code>returnTo</code> state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 call.</dd>
<dd><code>returnTo</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 to.</dd>
</dl>
</li>
</ul>
<a name="breakAndCallNext-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndCallNext</h4>
<pre>public static&nbsp;void&nbsp;breakAndCallNext(java.lang.String&nbsp;state,
java.lang.String&nbsp;returnTo)</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
<a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> with the specified id handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.
Before moving to the new state the current state will be recorded. The
next call to <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNow--"><code>breakAndReturnNow()</code></a> or <a href="../../../../org/apache/mina/statemachine/StateControl.html#breakAndReturnNext--"><code>breakAndReturnNext()</code></a>
will return to the specified <code>returnTo</code> state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</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 call.</dd>
<dd><code>returnTo</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 to.</dd>
</dl>
</li>
</ul>
<a name="breakAndReturnNow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>breakAndReturnNow</h4>
<pre>public static&nbsp;void&nbsp;breakAndReturnNow()</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
last recorded <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> handle the <strong>current</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</li>
</ul>
<a name="breakAndReturnNext--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>breakAndReturnNext</h4>
<pre>public static&nbsp;void&nbsp;breakAndReturnNext()</pre>
<div class="block">Breaks the execution of the current <a href="../../../../org/apache/mina/statemachine/transition/Transition.html" title="interface in org.apache.mina.statemachine.transition"><code>Transition</code></a> and lets the
last recorded <a href="../../../../org/apache/mina/statemachine/State.html" title="class in org.apache.mina.statemachine"><code>State</code></a> handle the <strong>next</strong> <a href="../../../../org/apache/mina/statemachine/event/Event.html" title="class in org.apache.mina.statemachine.event"><code>Event</code></a>.</div>
</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="class-use/StateControl.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/State.html" title="class in org.apache.mina.statemachine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/mina/statemachine/StateMachine.html" title="class in org.apache.mina.statemachine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/mina/statemachine/StateControl.html" target="_top">Frames</a></li>
<li><a href="StateControl.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2004-2019 <a href="http://mina.apache.org/">Apache MINA Project</a>. All Rights Reserved.</small></p>
</body>
</html>