com.crystaldecisions.reports.common
Class CrystalException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.crystaldecisions.reports.common.CrystalException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
FormulaFunctionCallException

public abstract class CrystalException
extends java.lang.Exception

The base class for almost all exceptions thrown by the Java Reporting Component, including FormulaFunctionCallException and other FormulaExceptions.

See Also:
Serialized Form

Constructor Summary
CrystalException(CrystalException otherException)
           Internal use only.
CrystalException(CrystalResourcesFactory resourcesFactory, java.lang.String resourceKey)
           Internal use only.
CrystalException(CrystalResourcesFactory resourcesFactory, java.lang.String resourceKey, java.lang.Object substitutionStrings)
           Internal use only.
CrystalException(CrystalResourcesFactory resourcesFactory, java.lang.String resourceKey, java.lang.Object substitutionStrings, java.lang.Throwable cause)
           Internal use only.
CrystalException(CrystalResourcesFactory resourcesFactory, java.lang.String resourceKey, java.lang.Throwable cause)
           Internal use only.
 
Method Summary
 java.lang.Throwable getCause()
           Gets the root cause of the exception.
 java.lang.String getLocalizedMessage(java.util.Locale locale)
           Gets the localized message from the resource bundle using the given locale.
 java.lang.String getMessage()
           Gets the localized message from the resource bundle using the default locale.
 java.lang.String getResourceKey()
           Gets the key used to retrieve a resource value from the resource bundle.
 void printStackTrace()
           Prints the stack trace.
 void printStackTrace(java.io.PrintStream s)
           Prints the stack trace to the location specified by the parameter s.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CrystalException

public CrystalException(CrystalResourcesFactory resourcesFactory,
                        java.lang.String resourceKey)

Internal use only.


CrystalException

public CrystalException(CrystalResourcesFactory resourcesFactory,
                        java.lang.String resourceKey,
                        java.lang.Throwable cause)

Internal use only.


CrystalException

public CrystalException(CrystalResourcesFactory resourcesFactory,
                        java.lang.String resourceKey,
                        java.lang.Object substitutionStrings)

Internal use only.


CrystalException

public CrystalException(CrystalResourcesFactory resourcesFactory,
                        java.lang.String resourceKey,
                        java.lang.Object substitutionStrings,
                        java.lang.Throwable cause)

Internal use only.


CrystalException

public CrystalException(CrystalException otherException)

Internal use only.

Method Detail

printStackTrace

public void printStackTrace()

Prints the stack trace.


printStackTrace

public void printStackTrace(java.io.PrintStream s)

Prints the stack trace to the location specified by the parameter s.

Parameters:
s - the PrintStream object to print the stack trace to

getCause

public java.lang.Throwable getCause()

Gets the root cause of the exception.

Returns:
a Throwable object

getResourceKey

public java.lang.String getResourceKey()

Gets the key used to retrieve a resource value from the resource bundle.

Returns:
a String that specifies the key

getMessage

public java.lang.String getMessage()

Gets the localized message from the resource bundle using the default locale.

Returns:
a String that specifies the localized message

getLocalizedMessage

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

Gets the localized message from the resource bundle using the given locale.

Returns:
a String that specifies the localized message