de.smartics.testdoc.report.index
Class UutPackageIndex

java.lang.Object
  de.smartics.testdoc.report.index.UutPackageIndex

All Implemented Interfaces:

ExportIndex, Serializable

public class UutPackageIndex
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      ExportIndex
     
     

Generates an index on the packages the UUT belong to.

Author:

Robert Reiner

See Also:

Serialized Form

Field Summary

static String

SECTION_NAME The name of the section generated by this index.

Constructor Summary

UutPackageIndex()
Default constructor.

Method Summary

void	addToIndex(UnitTestDoc testDoc) Adds the given test documentation instance to the index.
Section<UnitTestDoc>	getSection() Returns a reference to the root section of the index.
String	getSectionName() Returns the name of the section generated by this index.
boolean	isEmpty() Checks if this or any sub sections contains at least one item.

Methods inherited from class java.lang.Object

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

Field Detail

SECTION_NAME

public static final String SECTION_NAME

The name of the section generated by this index.

The value of this constant is "uutPackage".

Constant Field Value:

"uutPackage"

Constructor Detail

UutPackageIndex

public UutPackageIndex()

Default constructor.

Method Detail

getSectionName

public String getSectionName()

Returns the name of the section generated by this index.

Specified by:

getSectionName in interface ExportIndex

Returns:

the name of the generated section.

See Also:

ExportIndex.getSectionName()

addToIndex

public void addToIndex(UnitTestDoc testDoc)

Adds the given test documentation instance to the index.

Specified by:

addToIndex in interface ExportIndex

Parameters:

testDoc - the instance to be added.

See Also:

ExportIndex.addToIndex(de.smartics.testdoc.core.doc.UnitTestDoc)

getSection

public Section<UnitTestDoc> getSection()

Returns a reference to the root section of the index.

Specified by:

getSection in interface ExportIndex

Returns:

a reference to the root section of the index. Never returns null.

See Also:

ExportIndex.getSection()

isEmpty

public boolean isEmpty()

Checks if this or any sub sections contains at least one item.

Specified by:

isEmpty in interface ExportIndex

Returns:

true if at least one item is in this index, false otherwise.

See Also:

ExportIndex.isEmpty()