org.clapper.curn
Class FeedException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.clapper.util.misc.NestedException
              org.clapper.curn.CurnException
                  org.clapper.curn.FeedException

All Implemented Interfaces:

java.io.Serializable

public class FeedException
extends CurnException

FeedException is thrown when there's an error with a feed. It contains the corresponding FeedInfo object, and its getMessage() method includes the feed URL in the message.

Version:

$Revision: 6300 $

See Also:

Serialized Form

Constructor Summary

FeedException(FeedInfo feedInfo)
Default constructor, for an exception with no nested exception and no message.

FeedException(FeedInfo feedInfo, java.lang.String message)
Constructs an exception containing an error message, but no nested exception.

FeedException(FeedInfo feedInfo, java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg)
Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found).

FeedException(FeedInfo feedInfo, java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Object[] msgParams)
Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found).

FeedException(FeedInfo feedInfo, java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Object[] msgParams, java.lang.Throwable exception)
Constructs an exception containing a resource bundle name, a message key, a default message format (in case the resource bundle can't be found), arguments to be incorporated in the message via java.text.MessageFormat, and another exception.

FeedException(FeedInfo feedInfo, java.lang.String bundleName, java.lang.String messageKey, java.lang.String defaultMsg, java.lang.Throwable exception)
Constructs an exception containing a resource bundle name, a message key, a default message (in case the resource bundle can't be found), and another exception.

FeedException(FeedInfo feedInfo, java.lang.String message, java.lang.Throwable exception)
Constructs an exception containing another exception and a message.

FeedException(FeedInfo feedInfo, java.lang.Throwable exception)
Constructs an exception containing another exception, but no message of its own.

Method Summary

java.lang.String	getMessage() Returns the error message string for this exception.
java.lang.String	getMessage(java.util.Locale locale) Returns the error message string for this exception.

Methods inherited from class org.clapper.util.misc.NestedException

getMessages, getMessages, getMessages, getNestedException, printStackTrace, printStackTrace, printStackTrace, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedException

public FeedException(FeedInfo feedInfo)

Default constructor, for an exception with no nested exception and no message.

Parameters:

feedInfo - the FeedInfo object for the feed

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.Throwable exception)

Constructs an exception containing another exception, but no message of its own.

Parameters:

feedInfo - the FeedInfo object for the feed

exception - the exception to contain

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String message)

Constructs an exception containing an error message, but no nested exception.

Parameters:

feedInfo - the FeedInfo object for the feed

message - the message to associate with this exception

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String message,
                     java.lang.Throwable exception)

Constructs an exception containing another exception and a message.

Parameters:

feedInfo - the FeedInfo object for the feed

message - the message to associate with this exception

exception - the exception to contain

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String bundleName,
                     java.lang.String messageKey,
                     java.lang.String defaultMsg)

Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found). Using this constructor is equivalent to calling the FeedException(FeedInfo,String,String,String,Object[]) constructor, with a null pointer for the Object[] parameter. Calls to getMesage(Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to printStackTrace(PrintWriter,Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

feedInfo - the FeedInfo object for the feed

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

See Also:

FeedException(FeedInfo,String,String,String,Object[])

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String bundleName,
                     java.lang.String messageKey,
                     java.lang.String defaultMsg,
                     java.lang.Object[] msgParams)

Constructs an exception containing a resource bundle name, a message key, and a default message (in case the resource bundle can't be found). Using this constructor is equivalent to calling the FeedException(FeedInfo,String,String,String,Object[],Throwable) constructor, with a null pointer for the Object[] parameter. Calls to getMessage(Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to printStackTrace(PrintWriter,Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

feedInfo - the FeedInfo object for the feed

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

msgParams - parameters to the message, if any, or null

See Also:

FeedException(FeedInfo,String,String,String,Object[],Throwable)

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String bundleName,
                     java.lang.String messageKey,
                     java.lang.String defaultMsg,
                     java.lang.Throwable exception)

Constructs an exception containing a resource bundle name, a message key, a default message (in case the resource bundle can't be found), and another exception. Using this constructor is equivalent to calling the FeedException(FeedInfo,String,String,String,Object[],Throwable) constructor, with a null pointer for the Object[] parameter. Calls to getMessage(Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to printStackTrace(PrintWriter,Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

feedInfo - the FeedInfo object for the feed

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

exception - the exception to nest

See Also:

FeedException(FeedInfo,String,String,String,Object[],Throwable)

FeedException

public FeedException(FeedInfo feedInfo,
                     java.lang.String bundleName,
                     java.lang.String messageKey,
                     java.lang.String defaultMsg,
                     java.lang.Object[] msgParams,
                     java.lang.Throwable exception)

Constructs an exception containing a resource bundle name, a message key, a default message format (in case the resource bundle can't be found), arguments to be incorporated in the message via java.text.MessageFormat, and another exception. Calls to getMessage(Locale) will attempt to retrieve the top-most message (i.e., the message from this exception, not from nested exceptions) by querying the named resource bundle. Calls to printStackTrace(PrintWriter,Locale) will do the same, where applicable. The message is not retrieved until one of those methods is called, because the desired locale is passed into getMessage() and printStackTrace(), not this constructor.

Parameters:

feedInfo - the FeedInfo object for the feed

bundleName - resource bundle name

messageKey - the key to the message to find in the bundle

defaultMsg - the default message

msgParams - parameters to the message, if any, or null

exception - exception to be nested

See Also:

FeedException(FeedInfo,String,String,String,Object[])

Method Detail

getMessage

public java.lang.String getMessage()

Returns the error message string for this exception. If the exception was instantiated with a message of its own, then that message is returned. Otherwise, this method returns the class name, along with the class name of the first nested exception, if any. Unlike the parent Exception class, this method will never return null.

Overrides:

getMessage in class org.clapper.util.misc.NestedException

Returns:

the error message string for this exception

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Returns the error message string for this exception. If the exception was instantiated with a message of its own, then that message is returned. Otherwise, this method returns the class name, along with the class name of the first nested exception, if any. Unlike the parent Exception class, this method will never return null. If a localized version of the message is available, it will be returned.

Overrides:

getMessage in class org.clapper.util.misc.NestedException

Parameters:

locale - the locale to use, or null for the default

Returns:

the error message string for this exception