de.smartics.analysis.javadoc
Class JavadocException

Package class diagram package JavadocException
java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by de.smartics.analysis.javadoc.JavadocException
All Implemented Interfaces:
Serializable

public class JavadocException
     
     
extends Exception

Signals problems reported by the Javadoc tool.

Author:
Robert Reiner
See Also:
Serialized Form

Constructor Summary
JavadocException(String message, Console console)
          Convenience constructor.
JavadocException(String message, Throwable cause, Console console)
          Default constructor.
JavadocException(Throwable cause, Console console)
          Convenience constructor.
 
Method Summary
 Console getConsole()
          Returns the information provided by the Javadoc tool via the console.
 int getReturnCode()
          Returns the code returned by the Javadoc tool.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JavadocException

public JavadocException(String message,
                        Throwable cause,
                        Console console)
Default constructor.

Parameters:
message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
console - the information provided by the Javadoc tool via the console.
See Also:
Exception.Exception(java.lang.String,java.lang.Throwable)

JavadocException

public JavadocException(String message,
                        Console console)
Convenience constructor.

Parameters:
message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
console - the information provided by the Javadoc tool via the console.

JavadocException

public JavadocException(Throwable cause,
                        Console console)
Convenience constructor.

Parameters:
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
console - the information provided by the Javadoc tool via the console.
Method Detail

getConsole

public Console getConsole()
Returns the information provided by the Javadoc tool via the console.

Returns:
the information provided by the Javadoc tool via the console.

getReturnCode

public int getReturnCode()
Returns the code returned by the Javadoc tool.

Returns:
the code returned by the Javadoc tool.


Copyright © 2008-2011 Kronseder & Reiner GmbH - smartics. All Rights Reserved.