de.smartics.testdoc.collect.generator
Class TestDocGenerator

java.lang.Object
  de.smartics.testdoc.collect.generator.TestDocGenerator

public final class TestDocGenerator
     
     

      
      extends 
      
      Object
     
     

Run the generation of the test documentation files. This implementation makes running the compiler with the TestDocProcessor easier.

Author:

Robert Reiner

Nested Class Summary

static class

TestDocGenerator.Config The configuration to control the generation process.

Constructor Summary

TestDocGenerator(TestDocGenerator.Config config)
Default constructor.

Method Summary

void	generate() Generates the test documentation.
static void	runGenerator(TestDocGenerator.Config.Builder builder) Convenience method to create an instance of the generator by the builder information.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDocGenerator

public TestDocGenerator(TestDocGenerator.Config config)
                 throws IllegalArgumentException

Default constructor.

Parameters:

config - the configuration to control the generation process.

Throws:

IllegalArgumentException - if the config is null.

Method Detail

generate

public void generate()
              throws ExportException

Generates the test documentation.

Throws:

ExportException - if the process did not complete successfully.

runGenerator

public static void runGenerator(TestDocGenerator.Config.Builder builder)

Convenience method to create an instance of the generator by the builder information.

Parameters:

builder - the builder that contains the configuration information for the generation process.

Throws:

ExportException - if the process did not complete successfully.