edu.unm.cs.cs351.tdrl.f09.p1
Class CrawlFatalException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              edu.unm.cs.cs351.tdrl.f09.p1.CrawlFatalException

All Implemented Interfaces:

Serializable

public class CrawlFatalException
extends RuntimeException

This class indicates fatal errors in the execution of the Crawler suite. Errors of this type are expected to be non-recoverable and to cause a (clean) program shutdown.

Because this is a RuntimeException, it need not be declared in the throws clause of a method. (Formally, it is an unchecked exception.) However, it is good practice to document it via @throws clauses in your javadoc strings.

This class is only a marker class -- it exists for its name/type only. It does not add any functionality to (or modify any functionality of) the RuntimeException class. It contains only constructors that proxy up to the parent class.

Version:

1.0

Author:

terran

See Also:

Serialized Form

Constructor Summary

CrawlFatalException()
Construct a default Crawler exception, with no information about why it was generated.

CrawlFatalException(String msg)
Construct a Crawler exception with an informative message about why it was generated.

CrawlFatalException(String message, Throwable cause)
A combination of CrawlFatalException(String) and CrawlFatalException(Throwable) -- generate an exception with both an informative message and an original root cause.

CrawlFatalException(Throwable cause)
Construct a Crawler exception that "wraps" another, primary exception.

Method Summary

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

CrawlFatalException

public CrawlFatalException()

Construct a default Crawler exception, with no information about why it was generated. This is discouraged.

CrawlFatalException

public CrawlFatalException(String msg)

Construct a Crawler exception with an informative message about why it was generated.

Parameters:

msg - String describing the cause of the exception

CrawlFatalException

public CrawlFatalException(Throwable cause)

Construct a Crawler exception that "wraps" another, primary exception. This constructor is used when the original cause of the Crawler exception is that some other exception was generated. (For example, an IOException or somesuch.) You can then generate a Crawler-oriented exception, but keep a record of why it was generated -- what the root cause was.

Parameters:

cause - Exception that originally caused the whole mess

CrawlFatalException

public CrawlFatalException(String message,
                           Throwable cause)

A combination of CrawlFatalException(String) and CrawlFatalException(Throwable) -- generate an exception with both an informative message and an original root cause.

Parameters:

message - String describing the cause of the exception

cause - Exception that originally caused the whole mess