de.smartics.analysis.javadoc.log.message
Class IssueMessage

java.lang.Object
  de.smartics.analysis.javadoc.log.message.IssueMessage

All Implemented Interfaces:

Serializable

public class IssueMessage
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Serializable
     
     

Contains one message reported by the Javadoc tool.

Author:

Robert Reiner

See Also:

Serialized Form

Constructor Summary

IssueMessage(IssueLocation location, String message)
Default constructor.

IssueMessage(String message)
Convenience constructor if no location can be determined.

Method Summary

IssueLocation	getLocation() Returns the location of the issue.
String	getMessage() Returns the message text of the message.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueMessage

public IssueMessage(String message)
             throws NullPointerException,
                    IllegalArgumentException

Convenience constructor if no location can be determined.

Parameters:

message - the message text of the message.

Throws:

NullPointerException - if the message is null.

IllegalArgumentException - if the message is the empty string or contains only whitespaces.

IssueMessage

public IssueMessage(IssueLocation location,
                    String message)
             throws NullPointerException,
                    IllegalArgumentException

Default constructor.

Parameters:

location - the location of the issue. The location may be null if the location of the issue cannot be determined.

message - the message text of the message.

Throws:

NullPointerException - if the message is null.

IllegalArgumentException - if the message is the empty string or contains only whitespaces.

Method Detail

getLocation

public IssueLocation getLocation()

Returns the location of the issue. The location may be null if the location of the issue cannot be determined.

Returns:

the location of the issue.

getMessage

public String getMessage()

Returns the message text of the message.

Returns:

the message text of the message.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()