de.smartics.testdoc.report.index
Interface Section<T extends Serializable>

Type Parameters:

T - the type of the items added to this section.

All Superinterfaces:

Serializable

All Known Implementing Classes:

StaticSection

@NotThreadSafe
public interface Section<T extends Serializable>
     
     

      
      extends 
      
      Serializable
     
     

A section defines a collection of items that are grouped by a set of defined criteria.

Author:

Robert Reiner

Method Summary

void	addItem(T item) Adds the given item to this section.
void	addSubSection(Section<T> subSection) Adds the given sub section to this section.
boolean	containsSubSections() Checks if the given section contains sub sections.
List<T>	getItems() Returns the list of items associated with this section.
String	getName() Returns the name of this section.
Map<String,? extends Serializable>	getProperties() Returns the properties associated with this section.
List<Section<T>>	getSubSections() Returns the list of sub sections to this section.
boolean	isEmpty() Checks if this section or any sub sections contains at least one item.

Method Detail

getName

String getName()

Returns the name of this section.

Returns:

the name of this section.

getProperties

Map<String,? extends Serializable> getProperties()

Returns the properties associated with this section.

Returns:

the properties associated with this section.

addSubSection

void addSubSection(Section<T> subSection)

Adds the given sub section to this section.

Parameters:

subSection - the section to be added as sub section to this section.

getSubSections

List<Section<T>> getSubSections()

Returns the list of sub sections to this section.

Returns:

the list of sub sections to this section. The returned value is never null.

addItem

void addItem(T item)

Adds the given item to this section.

Parameters:

item - the item to be added to this section.

getItems

List<T> getItems()

Returns the list of items associated with this section.

Returns:

the list of items associated with this section. The returned value is never null.

isEmpty

boolean isEmpty()

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

Returns:

true if at least on item is contained, false if no item is contained.

containsSubSections

boolean containsSubSections()

Checks if the given section contains sub sections.

Returns:

true if at least on sub section is contained, false otherwise.