org.apache.flex.compiler.internal.graph

Class XMLGraphWriter

java.lang.Object

org.apache.flex.compiler.internal.graph.XMLGraphWriter

All Implemented Interfaces:

IReportWriter

Direct Known Subclasses:

GraphMLWriter, LinkReportWriter

public abstract class XMLGraphWriter
extends Object
implements IReportWriter

The base class of IReportWriter that transforms a DependencyGraph to output in XML

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	doc
protected DependencyGraph	graph
protected Collection<ICompilationUnit>	roots

Constructor Summary

Constructors

Constructor and Description
XMLGraphWriter(DependencyGraph graph, Collection<ICompilationUnit> roots) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected String	formatXMLStyleQName(String qname) Helper function to help format a qname String into the XML style of prefix:name that the old compiler used.
protected void	writeReport(OutputStream outStream) Writes this class's report Document to the OutputStream
abstract void	writeToStream(OutputStream outStream, Collection<ICompilerProblem> problems) Writes the current graph state and root compilation nodes to the output stream specified as a link report.

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected DependencyGraph graph

roots

protected Collection<ICompilationUnit> roots

doc

protected Document doc

Constructor Detail

XMLGraphWriter

public XMLGraphWriter(DependencyGraph graph,
              Collection<ICompilationUnit> roots)

Constructor

Parameters:

graph - A dependency graph for this graph writer

roots - The root compilation nodes to be written

Method Detail

writeToStream

public abstract void writeToStream(OutputStream outStream,
                 Collection<ICompilerProblem> problems)
                            throws InterruptedException

Description copied from interface: IReportWriter

Writes the current graph state and root compilation nodes to the output stream specified as a link report.

This should only be called when all compilation units are finished. There are no guarantees on the effects if called when compiler threads are still running.

Specified by:

writeToStream in interface IReportWriter

Parameters:

outStream - An OutputStream that the report will be written to

problems - A Collection of ICompilerProblem that this class will add to in case of exceptions or problems

Throws:

InterruptedException - can occur if this method is called while compilation is happening

writeReport

protected void writeReport(OutputStream outStream)
                    throws TransformerException

Writes this class's report Document to the OutputStream

Parameters:

outStream - The OutputStream that will be written to.

Throws:

IOException

TransformerException

formatXMLStyleQName

protected String formatXMLStyleQName(String qname)

Helper function to help format a qname String into the XML style of prefix:name that the old compiler used.

This currently just transforms the last '.' into a ':' if one exists.

Parameters:

qname - A String qname of format "package.name"

Returns:

A String qname of format "package:name"