|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.conversation.base.BasicCpStateMachineWriter
The BasicCpStateMachineWriter class frites a human-readable, multi-line, English-language description of a CpStateMachine.
This is defined for debugging and unit testing purposes.
Method Summary | |
---|---|
static java.lang.String |
stringForm(CpStateMachine stateMachine)
Returns a string containing a human-friendly English-language description of the given CpStateMachine. |
static void |
writeMessageDescription(java.io.Writer writer,
java.lang.String linePrefix,
MessageDescription desc)
Writes out, on the given writer, a human-friendly English-language description of the given MessageDescription. |
static void |
writeState(java.io.Writer writer,
java.lang.String linePrefix,
CpState state,
java.util.Collection parentRoles)
Writes out, on the given writer, a human-friendly English-language description of the given state. |
static void |
writeStateMachine(java.io.Writer writer,
java.lang.String linePrefix,
CpStateMachine stateMachine)
Writes, on the given writer, a human-friendly English-language description of the given CpStateMachine. |
static void |
writeStateTransition(java.io.Writer writer,
java.lang.String linePrefix,
CpStateTransition trans)
Writes out, on the given writer, a human-friendly English-language description of the given CpStateTransition. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static java.lang.String stringForm(CpStateMachine stateMachine)
stateMachine
- The state machine to be described.public static void writeStateMachine(java.io.Writer writer, java.lang.String linePrefix, CpStateMachine stateMachine) throws java.io.IOException
The description is multi-line, and intented. Each new line is prefixed with the
linePrefix
string followed by an appropriate amount of indentation.
writer
- The Writer on which to write the description.linePrefix
- The String to add to the start of each new line.stateMachine
- The state machine to be described.java.io.IOException
- If thrown by the Writer.public static void writeState(java.io.Writer writer, java.lang.String linePrefix, CpState state, java.util.Collection parentRoles) throws java.io.IOException
It's necessary to pass in the policy's roles in order to provide parent-role names for in-child states' role-maps.
writer
- The Writer on which to write the description.linePrefix
- The string to add to the start of each new line (e.g., for indentation).state
- The CpState to describe.parentRoles
- The roles defined in the CpStateMachine that owns the given state.java.io.IOException
- If thrown by the Writer.public static void writeStateTransition(java.io.Writer writer, java.lang.String linePrefix, CpStateTransition trans) throws java.io.IOException
writer
- The Writer on which to write the description.linePrefix
- The string to add to the start of each new line (e.g., for indentation).trans
- The CpStateTransition to describe.java.io.IOException
- If thrown by the Writer.public static void writeMessageDescription(java.io.Writer writer, java.lang.String linePrefix, MessageDescription desc) throws java.io.IOException
writer
- The Writer on which to write the description.linePrefix
- The string to add to the start of each new line (e.g., for indentation).desc
- The MessageDescription to be written out.java.io.IOException
- If thrown by the Writer.
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |