th.co.edge.jseq.sdedit
Class SdeditTextDiagram

java.lang.Object
  th.co.edge.jseq.sdedit.SdeditTextDiagram

All Implemented Interfaces:

Diagram

public class SdeditTextDiagram
extends java.lang.Object
implements Diagram

An SdeditTextDiagram is a Diagram that can be used to generate sequence diagrams as text files that can be read by the Quick Sequence Diagram Editor.

Constructor Summary

SdeditTextDiagram(ActivationList activationList)
Creates a new SdeditTextDiagram, using the given ActivationList as the basis for the sequence diagram.

Method Summary

void	save(java.io.File file) Creates a textual description of a sequence diagram understandable by the Quick Sequence Diagram Editor, and saves it to a text file.
java.lang.String	toString() Returns a string representation of this SdeditTextDiagram, currently in the form of comma-separated list of the root activations, not in the same form written to a file using the save method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SdeditTextDiagram

public SdeditTextDiagram(ActivationList activationList)

Creates a new SdeditTextDiagram, using the given ActivationList as the basis for the sequence diagram.

Parameters:

activationList - a list of root Activations to use when generating the sequence diagram

Method Detail

save

public void save(java.io.File file)
          throws java.io.IOException

Creates a textual description of a sequence diagram understandable by the Quick Sequence Diagram Editor, and saves it to a text file.

Specified by:

save in interface Diagram

Parameters:

file - the File to write to

Throws:

java.io.IOException - if something went wrong when creating or saving the diagram

toString

public java.lang.String toString()

Returns a string representation of this SdeditTextDiagram, currently in the form of comma-separated list of the root activations, not in the same form written to a file using the save method. This may change in the future.

Specified by:

toString in interface Diagram

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this SdeditTextDiagram