atg.epub
Class PublishingException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          atg.epub.PublishingException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InvalidAssetException

public class PublishingException
extends java.lang.Exception

This exception indicates that a severe error occured while performing a publishing operation.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

PublishingException()
Constructs a new PublishingException.

PublishingException(java.lang.String pStr)
Constructs a new PublishingException with the given explanation.

PublishingException(java.lang.String pResourceBundleName, java.lang.String pResourceKey, java.lang.Object[] pResourceParameters)
Constructs a new PublishingException with the given resource information.

PublishingException(java.lang.String pResourceBundleName, java.lang.String pResourceKey, java.lang.Object[] pResourceParameters, java.lang.Throwable pSourceException)
Constructs a new PublishingException with the given exception and appropriate resource information.

PublishingException(java.lang.String pStr, java.lang.Throwable pSourceException)
Constructs a new PublishingException with the given explanation and source exception.

PublishingException(java.lang.Throwable pSourceException)
Constructs a new PublishingException.

Method Summary

protected static java.lang.String	createMessage(java.lang.String pResourceBundleName, java.lang.String pResourceKey, java.lang.Object[] pResourceParameters) Returns the resource string already formatted.
java.lang.String	createUserMessage() Returns the resource string already formatted based on user locale.
java.lang.String	createUserMessage(java.util.Locale pLocale) Returns the resource string already formatted based on given locale.
java.lang.String	getErrorCode() Get property errorCode.
java.lang.String	getResourceBundleName() Returns property resourceBundleName.
java.lang.String	getResourceKey() Returns property resourceKey.
java.lang.Object[]	getResourceParameters() Returns property resourceParameters.
void	setErrorCode(java.lang.String pErrorCode) Set property errorCode.

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

PublishingException

public PublishingException()

Constructs a new PublishingException.

PublishingException

public PublishingException(java.lang.String pStr)

Constructs a new PublishingException with the given explanation.

PublishingException

public PublishingException(java.lang.Throwable pSourceException)

Constructs a new PublishingException.

Parameters:

pSourceException - the initial exception which was the root cause of the problem

PublishingException

public PublishingException(java.lang.String pStr,
                           java.lang.Throwable pSourceException)

Constructs a new PublishingException with the given explanation and source exception.

Parameters:

pSourceException - the initial exception which was the root cause of the problem

PublishingException

public PublishingException(java.lang.String pResourceBundleName,
                           java.lang.String pResourceKey,
                           java.lang.Object[] pResourceParameters)

Constructs a new PublishingException with the given resource information.

Parameters:

pResourceBundleName - the resource bundle containing the exception message

pResourceKey - the resource look-up key for the exception message

pResourceParameters - parameters to format into the resource string to create the exception message

PublishingException

public PublishingException(java.lang.String pResourceBundleName,
                           java.lang.String pResourceKey,
                           java.lang.Object[] pResourceParameters,
                           java.lang.Throwable pSourceException)

Constructs a new PublishingException with the given exception and appropriate resource information.

Parameters:

pResourceBundleName - the resource bundle containing the exception message

pResourceKey - the resource look-up key for the exception message

pResourceParameters - parameters to format into the resource string to create the exception message

pException - the root exception

Method Detail

setErrorCode

public void setErrorCode(java.lang.String pErrorCode)

Set property errorCode. This is the associated error code for this message. Currently for exceptions which report codes this is the corresponding resource bundle key.

Parameters:

pErrorCode - new value to set, may be null

getErrorCode

public java.lang.String getErrorCode()

Get property errorCode. This is the associated error code for this message. Currently for exceptions which report codes this is the corresponding resource bundle key.

Returns:

errorCode, may be null

getResourceBundleName

public java.lang.String getResourceBundleName()

Returns property resourceBundleName.
The ResourceBundle complete pathname containing the exception message.

Returns:

String

getResourceKey

public java.lang.String getResourceKey()

Returns property resourceKey.
The look-up key in the ResourceBundle for the exception message.

Returns:

String

getResourceParameters

public java.lang.Object[] getResourceParameters()

Returns property resourceParameters.
The parameters list formatted into into the resource string thus making the exception message.

Returns:

Object[]

createMessage

protected static java.lang.String createMessage(java.lang.String pResourceBundleName,
                                                java.lang.String pResourceKey,
                                                java.lang.Object[] pResourceParameters)

Returns the resource string already formatted.

createUserMessage

public java.lang.String createUserMessage()

Returns the resource string already formatted based on user locale.

createUserMessage

public java.lang.String createUserMessage(java.util.Locale pLocale)

Returns the resource string already formatted based on given locale.