de.smartics.properties.report.data
Class PropertyReportSet.Builder

java.lang.Object
  de.smartics.properties.report.data.PropertyReportSet.Builder

Enclosing class:

PropertyReportSet

public static final class PropertyReportSet.Builder
     
     

      
      extends 
      
      Object
     
     

Builder to create instances of enclosing class.

Constructor Summary

PropertyReportSet.Builder()

Method Summary

PropertyReportSet	build() Creates the report item.
PropertyReportSet.Builder	with(DocumentMetaData metadata) Set the document instance metadata.
PropertyReportSet.Builder	withComment(String comment) Sets the Javadoc comment to the descriptor.
PropertyReportSet.Builder	withPropertySetName(String name) Sets the name of the property set as read from the PropertySet annotation.
PropertyReportSet.Builder	withType(String type) Sets the type that defines the report set, if no name is specified explicitly.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyReportSet.Builder

public PropertyReportSet.Builder()

Method Detail

withPropertySetName

public PropertyReportSet.Builder withPropertySetName(String name)

Sets the name of the property set as read from the PropertySet annotation.

Parameters:

name - the name of the property set.

Returns:

a reference to the builder.

withType

public PropertyReportSet.Builder withType(String type)

Sets the type that defines the report set, if no name is specified explicitly.

Parameters:

type - the type that defines the report set, if no name is specified explicitly.

Returns:

a reference to the builder.

withComment

public PropertyReportSet.Builder withComment(String comment)

Sets the Javadoc comment to the descriptor.

Parameters:

comment - the Javadoc comment to the descriptor.

Returns:

a reference to the builder.

with

public PropertyReportSet.Builder with(DocumentMetaData metadata)
                               throws de.smartics.util.lang.NullArgumentException

Set the document instance metadata.

Parameters:

metadata - the document instance metadata.

Returns:

a reference to the builder.

Throws:

de.smartics.util.lang.NullArgumentException - if metadata is null.

build

public PropertyReportSet build()

Creates the report item.

Returns:

the report item.