org.opencms.widgets
Class CmsWidgetException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.opencms.main.CmsException
              org.opencms.widgets.CmsWidgetException

All Implemented Interfaces:

Serializable, I_CmsThrowable

public class CmsWidgetException
extends CmsException

Describes errors that occur in the context of the OpenCms widgets.

Since:

6.0.0

See Also:

Serialized Form

Field Summary

Fields inherited from class org.opencms.main.CmsException

m_message

Constructor Summary

CmsWidgetException(CmsMessageContainer container)
Creates a new localized Exception.

CmsWidgetException(CmsMessageContainer container, CmsWidgetDialogParameter widget)
Creates a new localized Exception.

CmsWidgetException(CmsMessageContainer container, Throwable cause)
Creates a new localized Exception that also containes a root cause.

CmsWidgetException(CmsMessageContainer container, Throwable cause, CmsWidgetDialogParameter widget)
Creates a new localized Exception that also containes a root cause.

Method Summary

CmsException	createException(CmsMessageContainer container, Throwable cause) Creates a copied instance of this localized exception.
CmsWidgetDialogParameter	getWidget() Returns the widget that caused the error.

Methods inherited from class org.opencms.main.CmsException

getFormattedErrorstack, getLocalizedMessage, getLocalizedMessage, getMessage, getMessageContainer, getStackTraceAsString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, 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

CmsWidgetException

public CmsWidgetException(CmsMessageContainer container)

Creates a new localized Exception.

Parameters:

container - the localized message container to use

CmsWidgetException

public CmsWidgetException(CmsMessageContainer container,
                          CmsWidgetDialogParameter widget)

Creates a new localized Exception.

Parameters:

container - the localized message container to use

widget - the widget that caused the error

CmsWidgetException

public CmsWidgetException(CmsMessageContainer container,
                          Throwable cause)

Creates a new localized Exception that also containes a root cause.

Parameters:

container - the localized message container to use

cause - the Exception root cause

CmsWidgetException

public CmsWidgetException(CmsMessageContainer container,
                          Throwable cause,
                          CmsWidgetDialogParameter widget)

Creates a new localized Exception that also containes a root cause.

Parameters:

container - the localized message container to use

cause - the Exception root cause

widget - the widget that caused the error

Method Detail

createException

public CmsException createException(CmsMessageContainer container,
                                    Throwable cause)

Description copied from class: CmsException

Creates a copied instance of this localized exception.

Overrides:

createException in class CmsException

Parameters:

container - the message container

cause - the root cause

Returns:

a copied instance of this localized exception

See Also:

CmsException.createException(org.opencms.i18n.CmsMessageContainer, java.lang.Throwable)

getWidget

public CmsWidgetDialogParameter getWidget()

Returns the widget that caused the error.

If the widget has not been set, this will return null.

Returns:

the widget that caused the error