net.ggtools.grand.graph
Interface GraphWriter

All Superinterfaces:

GraphConsumer

All Known Implementing Classes:

DotWriter

public interface GraphWriter
extends GraphConsumer

Interface for graph writers.

Author:

Christophe Labouisse

Method Summary

void	setShowGraphName(boolean showGraphName) Set wether or not the graph name should be display on the written graph.
void	write(java.io.File output) Write a project's graph to a file.
void	write(java.io.OutputStream stream) Write a project's graph to a stream.

Methods inherited from interface net.ggtools.grand.graph.GraphConsumer

setProducer

Method Detail

write

void write(java.io.File output)
           throws GrandException,
                  java.io.IOException

Write a project's graph to a file.

Parameters:

output - file to write the graph to.

Throws:

java.io.IOException - if the file cannot be written.

GrandException - if the graph cannot be written for a problem within Grand.

write

void write(java.io.OutputStream stream)
           throws GrandException

Write a project's graph to a stream.

Parameters:

stream - The stream to write to.

Throws:

GrandException - if the graph cannot be written for a problem within Grand.

setShowGraphName

void setShowGraphName(boolean showGraphName)

Set wether or not the graph name should be display on the written graph. The default value depends on the implementations.

Parameters:

showGraphName - true to display the graph name.