de.smartics.maven.apidoc
Class IssueMessageWrapper

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

 class IssueMessageWrapper
     
     

      
      extends 
      
      Object
     
     

Wraps a message to provide report specific information.

Author:

Robert Reiner

Constructor Summary

IssueMessageWrapper(Collection<String> sourceRoots, String xrefLocation, IssueMessage message)
Default constructor.

Method Summary

String	getClassName() Returns the name of the class the issue is located in.
IssueMessage	getMessage() Returns the message being wrapped.
String	getXref() Returns the reference to the class in the XRef report.

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueMessageWrapper

public IssueMessageWrapper(Collection<String> sourceRoots,
                           String xrefLocation,
                           IssueMessage message)

Default constructor.

Parameters:

sourceRoots - the base directories of the project where sources are found that are examined by the Javadoc tool. Used to construct references to the XRef report.

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

message - the message being wrapped.

Method Detail

getMessage

public IssueMessage getMessage()

Returns the message being wrapped.

Returns:

the message being wrapped.

getClassName

public String getClassName()

Returns the name of the class the issue is located in. The value is null if no class can be determined.

Returns:

the name of the class the issue is located in.

getXref

public String getXref()

Returns the reference to the class in the XRef report.

Returns:

the reference to the class in the XRef report.