Class RatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.rat.api.RatException

All Implemented Interfaces:

Serializable

public class RatException
extends Exception

This exception is used to indicate error conditions during RAT runs.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RatException()	Constructor.
RatException(String message)	Constructor with message only.
RatException(String message, Throwable cause)	Constructor with message and cause.
RatException(Throwable cause)	Constructor with cause only.

Method Summary

Modifier and Type	Method	Description
static RatException	makeRatException(Exception exception)	Creates a RatException out of any other type of exception.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

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

Constructor Details

RatException

public RatException()

Constructor.

RatException

public RatException(String message,
 Throwable cause)

Constructor with message and cause.

Parameters:

message - an error message to give more context.

cause - a cause.

RatException

public RatException(String message)

Constructor with message only.

Parameters:

message - an error message to give more context.

RatException

public RatException(Throwable cause)

Constructor with cause only.

Parameters:

cause - a cause.

Method Details

makeRatException

public static RatException makeRatException(Exception exception)

Creates a RatException out of any other type of exception. If the exception is already a RatException, just return it.

Parameters:

exception - the exception to convert.

Returns:

a RatException.