ilog.views.sdm

Class IlvSDMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

ilog.views.sdm.IlvSDMException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IlvNotAnSDMDocumentException

public class IlvSDMException
extends Exception

Exceptions of the class IlvSDMException are thrown by various classes of the ilog.views.sdm package.

This class is mainly used to encapsulate low-level exceptions such as exceptions thrown by an XML parser, without polluting the API with too many exception types.

Since:

JViews 4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvSDMException() Creates a new SDM exception with no error message.
IlvSDMException(String message) Creates a new SDM exception with a specified error message.
IlvSDMException(String message, Throwable cause) Creates a new IlvSDMException with the specified detail detail message and cause.
IlvSDMException(Throwable cause) Constructs a new IlvSDMException with the specified cause.

Method Summary

Modifier and Type	Method and Description
Throwable	getCause() Returns the cause of this IlvSDMException or null if the cause is nonexistent or unknown.
Exception	getException() Deprecated. Please use the method getCause() instead.
String	getMessage() Returns the detail message for this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, 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

IlvSDMException

public IlvSDMException()

Creates a new SDM exception with no error message.

IlvSDMException

public IlvSDMException(String message)

Creates a new SDM exception with a specified error message.

Parameters:

message - The error message.

IlvSDMException

public IlvSDMException(Throwable cause)

Constructs a new IlvSDMException with the specified cause. The message of the cause is used as the message for the IlvSDMException instance.

Parameters:

cause - The cause, this is saved for later retrieval by the getCause() method. Set this value to null to indicate that the cause is nonexistent or unknown.

Since:

JViews 8.1

IlvSDMException

public IlvSDMException(String message,
                       Throwable cause)

Creates a new IlvSDMException with the specified detail detail message and cause.

The cause is embedded in the new IlvSDMException. However, the new exception will have its own message.

Parameters:

message - The detail message. This is saved for later retrieval by the getMessage() method.

cause - The cause. This is saved for later retrieval by the getCause() method. Set this value to null to indicate that the cause is nonexistent or unknown.

Since:

JViews 8.1

Method Detail

getException

@Deprecated
public Exception getException()

Deprecated. Please use the method getCause() instead.

Returns the low-level exception that caused this SDM exception to be thrown.

Returns:

The low-level exception, or null if this SDM exception was not thrown due to a lower-level exception but rather by the code of the ilog.views.sdm package itself.

getMessage

public String getMessage()

Returns the detail message for this exception.

If there is an embedded exception, and if the IlvSDMException has no detail message of its own, this method returns the detail message from the embedded exception.

Overrides:

getMessage in class Throwable

Returns:

The error or warning message.

getCause

public Throwable getCause()

Returns the cause of this IlvSDMException or null if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to get thrown.)

This implementation returns the cause that was supplied via one of the constructors requiring a Throwable, or that was set after creation with the Throwable.initCause(Throwable) method.

Overrides:

getCause in class Throwable

Returns:

The cause of this IlvSDMException or null if the cause is nonexistent or unknown.