org.apache.flex.compiler.internal.graph

Class LinkReportWriter

java.lang.Object

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

org.apache.flex.compiler.internal.graph.LinkReportWriter

All Implemented Interfaces:

IReportWriter

public class LinkReportWriter
extends XMLGraphWriter
implements IReportWriter

Class to write a DependencyGraph as a XML link report.

This graph will walk through the graph from the ICompilationUnit stored in roots and construct a XML link report.

This has mostly been kept consistent with the link report from the old flex compiler, however a few differences remain. We may link different things from the framework, or the old compiler might have failed to find certain dependencies.

Without a concrete spec, this class is still a work in progress

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkReportWriter.QNameComparator A Comparator that sorts qnames String based on alphabetical order.

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.graph.XMLGraphWriter

doc, graph, roots

Constructor Summary

Constructors

Constructor and Description
LinkReportWriter(DependencyGraph graph, List<ICompilationUnit> roots, LinkageChecker linkageChecker)

Method Summary

Methods

Modifier and Type	Method and Description
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 org.apache.flex.compiler.internal.graph.XMLGraphWriter

formatXMLStyleQName, writeReport

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkReportWriter

public LinkReportWriter(DependencyGraph graph,
                List<ICompilationUnit> roots,
                LinkageChecker linkageChecker)

Method Detail

writeToStream

public 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

Specified by:

writeToStream in class XMLGraphWriter

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