de.smartics.testdoc.report.export.doc
Class IndexProvider

java.lang.Object
  de.smartics.testdoc.report.export.doc.IndexProvider

public class IndexProvider
     
     

      
      extends 
      
      Object
     
     

Checks whether or not the test documentation has been gathered successfully.

This is a simple implementation that checks, whether there is accessible information stored either in the JMX bean or a singleton index of serialized files.

Constructor Summary

IndexProvider(String serializedRootDir)
Convenience constructor using JMX object name JmxExportAdapterClient.OBJECT_NAME.

IndexProvider(String jmxObjectName, String serializedRootDir)
Default constructor.

Method Summary

TestDocHelper

createHelper(ReportConfig config) Creates the helper that essentially encapsulates the index of test documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexProvider

public IndexProvider(String serializedRootDir)
              throws NullPointerException

Convenience constructor using JMX object name JmxExportAdapterClient.OBJECT_NAME.

Parameters:

serializedRootDir - the location where the serialized files with test doc information is expected.

Throws:

NullPointerException - if serDir is null.

IndexProvider

public IndexProvider(String jmxObjectName,
                     String serializedRootDir)
              throws NullPointerException

Default constructor.

Parameters:

jmxObjectName - the name of the JMX bean that provides acces to the generated index.

serializedRootDir - the location where the serialized files with test doc information is expected.

Throws:

IllegalStateException - if the jmxObjectName is not valid.

NullPointerException - if the jmxObjectName or serDir is null.

Method Detail

createHelper

public TestDocHelper createHelper(ReportConfig config)

Creates the helper that essentially encapsulates the index of test documentation.

Parameters:

config - the configuration to be used by the helper.

Returns:

the created helper instance.