de.smartics.maven.apidoc
Class JavadocMessageConfig.Builder

java.lang.Object
  de.smartics.maven.apidoc.JavadocMessageConfig.Builder

Enclosing class:

JavadocMessageConfig

public static final class JavadocMessageConfig.Builder
     
     

      
      extends 
      
      Object
     
     

Builder for the configuration instance.

Constructor Summary

JavadocMessageConfig.Builder()

Method Summary

JavadocMessageConfig	build() The builder to create the configuration.
void	setBundle(ResourceBundle bundle) Sets the resource bundle to fetch messages to be rendered into the report.
void	setMessageFilter(Collection<String> messageFilter) Sets the list of message fragments that are used to filter messages.
void	setNoticeMessagesRendered(boolean noticeMessagesRendered) Sets the flag that indicates if notice messages should be rendered in the report (true) or if only error and warn messages are rendered ( false).
void	setSourceRoots(Collection<String> sourceRoots) Sets the root directories in which the source files reside.
void	setXrefLocation(String xrefLocation) Sets the location where the XRef report is written to.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocMessageConfig.Builder

public JavadocMessageConfig.Builder()

Method Detail

setBundle

public void setBundle(ResourceBundle bundle)

Sets the resource bundle to fetch messages to be rendered into the report.

Parameters:

bundle - the resource bundle to fetch messages to be rendered into the report.

setXrefLocation

public void setXrefLocation(String xrefLocation)

Sets the location where the XRef report is written to.

Parameters:

xrefLocation - the location where the XRef report is written to.

build

public JavadocMessageConfig build()
                           throws IllegalArgumentException

The builder to create the configuration.

Returns:

the configuration instance.

Throws:

IllegalArgumentException - if the builder information does not meet the constraints.

setNoticeMessagesRendered

public void setNoticeMessagesRendered(boolean noticeMessagesRendered)

Sets the flag that indicates if notice messages should be rendered in the report ( true) or if only error and warn messages are rendered ( false).

Parameters:

noticeMessagesRendered - the flag that indicates if notice messages should be rendered in the report ( true) or if only error and warn messages are rendered ( false).

setSourceRoots

public void setSourceRoots(Collection<String> sourceRoots)

Sets the root directories in which the source files reside. The file names are expected to be disjunct so that no directory is contained in another one.

Parameters:

sourceRoots - the root directories in which the source files reside.

setMessageFilter

public void setMessageFilter(Collection<String> messageFilter)

Sets the list of message fragments that are used to filter messages. If a message contains a fragment found in the list, it will be suppressed.

Parameters:

messageFilter - the list of message fragments that are used to filter messages.