de.smartics.maven.apidoc
Class JavadocMessageConfig

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

public final class JavadocMessageConfig
     
     

      
      extends 
      
      Object
     
     

Configuration to control the rendering of the report.

Author:

Robert Reiner

Nested Class Summary

static class

JavadocMessageConfig.Builder Builder for the configuration instance.

Method Summary

List<IssueMessage>	filter(List<IssueMessage> messages) Creates a copy of the passed in messages that contains only those messages that are note filtered.
ResourceBundle	getBundle() Returns the resource bundle to fetch messages to be rendered into the report.
String	getFooterText() Returns the text to be rendered in the footer.
Locale	getLocale() Returns the locale to use for the report.
Collection<String>	getSourceRoots() Returns the root directories in which the source files reside.
String	getXrefLocation() Returns the location where the XRef report is written to.
boolean	isNoticeMessagesRendered() Returns the flag that indicates if notice messages should be rendered in the report (true) or if only error and warn messages are rendered ( false).

Methods inherited from class java.lang.Object

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

Method Detail

getSourceRoots

public Collection<String> getSourceRoots()

Returns 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.

Returns:

the root directories in which the source files reside.

getBundle

public ResourceBundle getBundle()

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

Returns:

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

getLocale

public Locale getLocale()

Returns the locale to use for the report.

Returns:

the locale to use for the report.

getXrefLocation

public String getXrefLocation()

Returns the location where the XRef report is written to.

Returns:

the location where the XRef report is written to.

getFooterText

public String getFooterText()

Returns the text to be rendered in the footer. Contains markup so it is required to be rendered as raw text.

Returns:

the footer text.

isNoticeMessagesRendered

public boolean isNoticeMessagesRendered()

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

Returns:

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

filter

public List<IssueMessage> filter(List<IssueMessage> messages)

Creates a copy of the passed in messages that contains only those messages that are note filtered.

Parameters:

messages - the messages to filter.

Returns:

the filtered messages.