biz.hammurapi.codegen
Class HtmlDocConsumer

java.lang.Object
  biz.hammurapi.codegen.HtmlDocConsumer

All Implemented Interfaces:

Consumer, DocumentingConsumer

public class HtmlDocConsumer
extends java.lang.Object
implements DocumentingConsumer

Stores generated class files in a specified directory and creates HTML documenation.

Version:

$Revision: 1.5 $

Author:

Pavel Vlasov

Constructor Summary

HtmlDocConsumer(java.io.File classDir, java.io.File docDir, java.lang.String indexName)
Construcotor

Method Summary

void	close() Closes all files.
void	consume(org.apache.bcel.classfile.JavaClass javaClass)
GenerationListener	getListener()

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlDocConsumer

public HtmlDocConsumer(java.io.File classDir,
                       java.io.File docDir,
                       java.lang.String indexName)
                throws GenerationException

Construcotor

Parameters:

classDir - Output directory for generated classes. Mandatory.

docDir - Output directory for HTML documentation. Optional (can be null).

indexName - Name of index file.

Throws:

GenerationException

Method Detail

consume

public void consume(org.apache.bcel.classfile.JavaClass javaClass)
             throws GenerationException

Specified by:

consume in interface Consumer

Throws:

GenerationException

getListener

public GenerationListener getListener()

Specified by:

getListener in interface Consumer

close

public void close()

Closes all files.

Specified by:

close in interface DocumentingConsumer