com.crystaldecisions.sdk.exception
Class SDKRuntimeException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.crystaldecisions.sdk.exception.SDKRuntimeException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SDKRuntimeException.ContradictingValues, SDKRuntimeException.ObjectNotFound, SDKRuntimeException.OutOfRange, SDKRuntimeException.PropertyNotFound, SDKRuntimeException.SetInherited, SDKRuntimeException.UndefinedValue, SDKRuntimeException.Unexpected, SDKRuntimeException.UnexpectedValue

public class SDKRuntimeException

extends java.lang.RuntimeException

This class defines runtime exceptions that the SDK may throw.

See Also:

Serialized Form

Nested Class Summary

static class	SDKRuntimeException.ContradictingValues This exception is thrown when two values in the InfoObject have contradicting values.
static class	SDKRuntimeException.ObjectNotFound This exception is thrown when an unknown object ID is encountered.
static class	SDKRuntimeException.OutOfRange This exception is thrown when an input value is out of the expected range
static class	SDKRuntimeException.PropertyNotFound This exception is thrown when an unknown property ID is encountered.
static class	SDKRuntimeException.SetInherited This exception is thrown when an exception is encountered that results from the SetInherited class.
static class	SDKRuntimeException.UndefinedValue This exception is thrown when an unexpected value is encountered.
static class	SDKRuntimeException.Unexpected This exception describes an unexpected runtime problem.
static class	SDKRuntimeException.UnexpectedValue This exception is thrown when an unexpected value is encountered.

Method Summary

static void	checkPositive(java.lang.Integer propId, int value) Determines whether the unexpected value is positive.
static void	checkRange(java.lang.Integer propId, double value, double lowerbound, double upperbound) Determines whether the value is out of range.
static void	checkRange(java.lang.Integer propId, int value, int lowerbound, int upperbound) Determines whether the value is out of range.
java.lang.String	getDetail() Gets the detailed error message used for diagnosis.
java.lang.String	getMessage() Returns the error message of this throwable object.
java.lang.String	getMessage(java.util.Locale locale) Returns the localized error message of this throwable object.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

checkPositive

public static void checkPositive(java.lang.Integer propId,
                                 int value)

Determines whether the unexpected value is positive.

Parameters:

propId - An Integer that represents the property ID.

value - An int that represents the value.

checkRange

public static void checkRange(java.lang.Integer propId,
                              double value,
                              double lowerbound,
                              double upperbound)

Determines whether the value is out of range.

Parameters:

propId - An Integer that represents the property ID.

value - A double that represents the value.

lowerbound - A double that represents the lower bound.

upperbound - A double that represents the upper bound.

checkRange

public static void checkRange(java.lang.Integer propId,
                              int value,
                              int lowerbound,
                              int upperbound)

Determines whether the value is out of range.

Parameters:

propId - An Integer that represents the property ID.

value - An int that represents the value.

lowerbound - An int that represents the lower bound.

upperbound - An int that represents the upper bound.

getMessage

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

Returns the localized error message of this throwable object.

Parameters:

locale - The locale-specific properties that the message string will use.

Returns:

A String containing the error message string of this Throwable object if it was created with an error message string or null if it was created with no error message.

getDetail

public java.lang.String getDetail()

Gets the detailed error message used for diagnosis. The string will contain the stack trace, and nested exceptions if applicable. This string is only available in English.

Returns:

The detail string.

getMessage

public java.lang.String getMessage()

Returns the error message of this throwable object.

Overrides:

getMessage in class java.lang.Throwable

Returns:

A String containing the error message string of this Throwable object if it was created with an error message string or null if it was created with no error message.