Java Doc for StateMachine.java in  » Science » Cougaar12_4 » org » cougaar » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.cougaar.util.StateMachine

All known Subclasses:   org.cougaar.util.StackMachine,
StateMachine
public class StateMachine (Code)
A little state machine framework to allow proper sequencing of a set of logical states.

Inner Class :abstract public static class State
Inner Class :public static class IllegalStateException extends RuntimeException

Field Summary
final public static  StateDONE
    
final public static  StateERROR
     Error state.
final public static  StateUNINITIALIZED
     Default state from which you cannot transit anywhere.

Constructor Summary
public  StateMachine()
    

Method Summary
protected  void_set(State s)
    
public synchronized  Stateadd(State s)
     Add a State to the machine.
public  voidaddLink(String startTag, String nextTag)
    
final public synchronized  StategetState()
    
public synchronized  voidgo()
    
final public synchronized  booleanisDone()
    
public synchronized  voidreset(State s)
     like set, except allows a machine to jump states.
final public synchronized  voidreset(String k)
    
public synchronized  voidset(State s)
     Sets the State of the machine.
final public synchronized  voidset(String k)
    
public synchronized  booleanstep()
     Invoke a single step to see if we should transit out of the current state.
public synchronized  voidstepUntilDone()
    
final protected synchronized  voidtransit(State s)
    
final protected synchronized  voidtransit(String k)
    
protected synchronized  voidtransit(State oldState, State newState)
     Transit from oldState to newState.

Field Detail
DONE
final public static State DONE(Code)
Machine is fulfilled - will not progress from this state *



ERROR
final public static State ERROR(Code)
Error state. The Machine will require a reset in order to progress *



UNINITIALIZED
final public static State UNINITIALIZED(Code)
Default state from which you cannot transit anywhere. *




Constructor Detail
StateMachine
public StateMachine()(Code)




Method Detail
_set
protected void _set(State s)(Code)



add
public synchronized State add(State s)(Code)
Add a State to the machine. A state with the same key as an old state will be replaced and the old one returned.



addLink
public void addLink(String startTag, String nextTag)(Code)
Add a direct link between two tags *



getState
final public synchronized State getState()(Code)
Return the current state *



go
public synchronized void go()(Code)
call step repeatedly until the machine doesn't transit *



isDone
final public synchronized boolean isDone()(Code)



reset
public synchronized void reset(State s)(Code)
like set, except allows a machine to jump states. This is important primarily if you want to reset a machine to the initial state.



reset
final public synchronized void reset(String k)(Code)



set
public synchronized void set(State s)(Code)
Sets the State of the machine. Use #reset(State) instead if explicitly skipping states or resetting a machine back to start.
throws:
  IllegalStateException - When entering ERROR or if skipping a state, e.g. if two sets are done in sequence without the opportunity to process the first one.



set
final public synchronized void set(String k)(Code)



step
public synchronized boolean step()(Code)
Invoke a single step to see if we should transit out of the current state. If the machine is "DONE" then no state will be invoked: perpetual no-op unless the machine is rest. If the machine is in UNINITIALIZED or ERROR state, then an IllegalStateException will be thrown. true IFF the current state invoked a transit method.



stepUntilDone
public synchronized void stepUntilDone()(Code)
Step until getState() returns DONE *



transit
final protected synchronized void transit(State s)(Code)



transit
final protected synchronized void transit(String k)(Code)



transit
protected synchronized void transit(State oldState, State newState)(Code)
Transit from oldState to newState. Default implementation merely calls set(newState)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.