laser.util
Interface Visualizable

All Known Subinterfaces:
AlphabetInterface<L>, ArtifactInterface, DFAInterface<L>, FSAInterface<L>, MutableDFAInterface<L>, MutableFSAInterface<L>, RunnableDFAInterface<L>, RunnableFSAInterface<L>
All Known Implementing Classes:
AbstractFSA, AbstractMutableFSA, AbstractRunnableFSA, Alphabet, IndexedAlphabet, MutableDFA, MutableFSA, RE, RunnableDFA, RunnableFSA

public interface Visualizable

The Visualizable interface allows the user to output the visual form of an object. This is helpful for code understanding and debugging purposes.

Author:
Heather M. Conboy (laser-software@cs.umass.edu)

Method Summary
 java.lang.String getVisExtension()
          Gets the file extension that will be used for the visual form of this object.
 void visualize(java.lang.String filename)
          Outputs the visual form of this object to the given file.
 void visualize(java.io.Writer out)
          Outputs the visual form of this object to the given Writer.
 

Method Detail

getVisExtension

java.lang.String getVisExtension()
Gets the file extension that will be used for the visual form of this object.

Returns:
The visual file extension

visualize

void visualize(java.lang.String filename)
               throws java.io.IOException,
                      VisualizableException
Outputs the visual form of this object to the given file.

Parameters:
filename - The file to output the visual form to
Throws:
java.io.IOException - an IO error during the write
VisualizableException - an error occured while creating the visual form of the artifact

visualize

void visualize(java.io.Writer out)
               throws java.io.IOException,
                      VisualizableException
Outputs the visual form of this object to the given Writer.

Parameters:
out - a Writer to output the visual form to
Throws:
java.io.IOException - an IO error during the write
VisualizableException - an error occured while creating the visual form of the artifact