IfsException (ecmsdk-api 3.7.0 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - oracle.ifs.common.IfsException

All Implemented Interfaces:

Serializable, Cloneable
```
public class IfsException
extends Exception
implements Cloneable
```
An IfsException represents an iFS error condition.
Each IfsException has an integer error code that specifies the type of error encountered.
An IfsException may also have an array of object parameters that can be substituted into a string (obtained from the iFS resource bundle) using java.text.MessageFormat to produce a more descriptive, localized error message.
An exception often leads to another higher-level exception, which in turn may result in even higher-level exceptions. Although only the top-level exception is presented to the application by the iFS API, an IfsException keeps track of the underlying, or "nested", exceptions (or more precisely, the nested java.lang.Throwables). For any IfsException, the immediately underlying Throwable can be obtained by calling the method getNestedThrowable.

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Published)

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`m_ErrorCode` The error code.
`protected Object`	`m_Info` The exception information.
`protected String`	`m_InfoDescription` The description (identifer) for the exception information,
`protected Throwable`	`m_NestedThrowable` The Throwable that led to this IfsException.
`protected Throwable`	`m_OriginatingThrowable` The last Throwable in the chain.
`protected Object[]`	`m_Parameters` The error message parameters.
`protected String`	`m_RemoteBacktrace` If this IfsException was thrown in a different process, the backtrace in that process; null otherwise.
`protected static boolean`	`s_VerboseMessage` Whether `toString` and `toLocalizedString` produce concise or verbose messages.

Constructor Summary

Constructors
Constructor and Description
`IfsException(int errorCode)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters, String infoDescription, Object info)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters, Throwable nestedThrowable)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters, Throwable nestedThrowable, String infoDescription, Object info)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters, Throwable nestedThrowable, Traceable object)` Constructs an IfsException.
`IfsException(int errorCode, Object[] parameters, Traceable object)` Constructs an IfsException.
`IfsException(int errorCode, String infoDescription, Object info)` Constructs an IfsException.
`IfsException(int errorCode, Throwable nestedThrowable)` Constructs an IfsException.
`IfsException(int errorCode, Throwable nestedThrowable, String infoDescription, Object info)` Constructs an IfsException.
`IfsException(int errorCode, Throwable nestedThrowable, Traceable object)` Constructs an IfsException.
`IfsException(int errorCode, Traceable object)` Constructs an IfsException.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsErrorCode(int errorCode)` Gets whether this IfsException or any nested IfsExceptions have the specified error code.
`IfsException`	`fillInRemoteStackTrace()` Sets the remote backtrace of this IfsException.
`void`	`fillInRemoteStackTrace(String backtrace)` Fills in the remote backtrace of this IfsException to the specified string.
`int`	`getErrorCode()` Gets the error code of this IfsException.
`Object`	`getInfo()` Gets the exception information.
`String`	`getInfoDescription()` Gets the description of the exception information.
`String`	`getLocalizedMessage()` Gets the description of this IfsException for the default locale of the Java VM.
`String`	`getLocalizedMessage(LibrarySessionInterface session)` Gets the description of this IfsException for the locale of the specified session's Localizer.
`String`	`getLocalizedMessage(Localizer localizer)` Gets the description of this IfsException for the locale of the specified Localizer.
`String`	`getMessage()` Gets the US English description of this IfsException.
`Exception`	`getNestedException()` Deprecated. iFS 9.0 use getNestedThrowable
`IfsException`	`getNestedIfsException(int errorCode)` Gets a nested IfsException that matches the specified error code.
`Throwable`	`getNestedThrowable()` Gets the Throwable that led to this IfsException.
`Object[]`	`getParameters()` Gets the parameter values for the error message.
`void`	`ignoreObjectNotFoundException()` Re-throw the target exception unless it reflects an "object not found" condition.
`static boolean`	`isVerboseMessage()` Gets whether `toString` and `toLocalizedString` produces verbose messages.
`void`	`printLocalizedStackTrace()` Prints the stack trace of this IfsException to the standard error stream, using the default locale of the Java VM.
`void`	`printLocalizedStackTrace(LibrarySessionInterface session)` Prints the stack trace of this IfsException to the standard error stream, using the locale of the specified session's Localizer.
`void`	`printLocalizedStackTrace(Localizer localizer)` Prints the stack trace of this IfsException to the standard error stream, using the locale of the specified Localizer.
`void`	`printLocalizedStackTrace(PrintStream stream)` Prints the stack trace of this IfsException to the specified PrintStream, using the default locale of the Java VM.
`void`	`printLocalizedStackTrace(PrintStream stream, LibrarySessionInterface session)` Prints the stack trace of this IfsException to the specified PrintStream, using the locale of the specified session's Localizer.
`void`	`printLocalizedStackTrace(PrintStream stream, Localizer localizer)` Prints the stack trace of this IfsException to the specified PrintStream, using the locale of the specified Localizer.
`void`	`printLocalizedStackTrace(PrintWriter writer)` Prints the stack trace of this IfsException to the specified PrintWriter, using the default locale of the Java VM.
`void`	`printLocalizedStackTrace(PrintWriter writer, LibrarySessionInterface session)` Prints the stack trace of this IfsException to the specified PrintWriter, using the locale of the specified session's Localizer.
`void`	`printLocalizedStackTrace(PrintWriter writer, Localizer localizer)` Prints the stack trace of this IfsException to the specified PrintWriter, using the locale of the specified Localizer.
`void`	`printStackTrace()` Prints the stack trace of this IfsException to the standard error stream, using US English.
`void`	`printStackTrace(PrintStream stream)` Prints the stack trace of this IfsException to the specified PrintStream, using US English.
`void`	`printStackTrace(PrintWriter writer)` Prints the stack trace of this IfsException to the specified PrintWriter, using US English.
`static void`	`setVerboseMessage(boolean verbose)` Specifies whether `toString` and `toLocalizedString` produces verbose messages.
`String`	`toLocalizedString()` Represents this IfsException as a localized string, using the default locale of the Java VM.
`String`	`toLocalizedString(LibrarySessionInterface session)` Represents this IfsException as a localized string, using the locale of the specified session's Localizer.
`String`	`toLocalizedString(Localizer localizer)` Represents this IfsException as a localized string, using the locale of the specified Localizer.
`String`	`toString()` Represents this IfsException as a US English string.

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, setStackTrace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_ErrorCode
```
protected int m_ErrorCode
```
    The error code.
    
    (Unpublished)
  - m_Parameters
```
protected Object[] m_Parameters
```
    The error message parameters.
    
    (Unpublished)
  - m_InfoDescription
```
protected String m_InfoDescription
```
    The description (identifer) for the exception information,
    
    (Unpublished)
  - m_Info
```
protected Object m_Info
```
    The exception information.
    
    (Unpublished)
  - m_NestedThrowable
```
protected Throwable m_NestedThrowable
```
    The Throwable that led to this IfsException.
    
    (Unpublished)
  - m_OriginatingThrowable
```
protected Throwable m_OriginatingThrowable
```
    The last Throwable in the chain.
    
    (Unpublished)
  - m_RemoteBacktrace
```
protected String m_RemoteBacktrace
```
    If this IfsException was thrown in a different process, the backtrace in that process; null otherwise.
    
    (Unpublished)
  - s_VerboseMessage
```
protected static boolean s_VerboseMessage
```
    Whether toString and toLocalizedString produce concise or verbose messages.
    Verbose messages include the messages of nested Throwables.
    
    (Unpublished)
- Constructor Detail
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters,
                    Throwable nestedThrowable,
                    String infoDescription,
                    Object info)
```
    Constructs an IfsException.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    nestedThrowable - the Throwable that led to this IfsException
    
    infoDescription - description of the exception information
    
    info - the exception information
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters,
                    Throwable nestedThrowable)
```
    Constructs an IfsException.
    This constructor variant is used when the error message has no included information.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    nestedThrowable - the Throwable that led to this IfsException
    
    (Published)
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters,
                    Throwable nestedThrowable,
                    Traceable object)
```
    Constructs an IfsException.
    This constructor variant is used when the error message has no included information.
    This variant also issues a trace on the CHANNEL_EXCEPTION channel of level LEVEL_ERROR.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    nestedThrowable - the Throwable that led to this IfsException
    
    object - the Traceable associated with the IfsException
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    Throwable nestedThrowable)
```
    Constructs an IfsException.
    This constructor variant is used when the error message for the specified error code has no parameters and no included information.
    
    Parameters:
    
    errorCode - the error code
    
    nestedThrowable - the Throwable that led to this IfsException
    
    (Published)
  - IfsException
```
public IfsException(int errorCode,
                    Throwable nestedThrowable,
                    Traceable object)
```
    Constructs an IfsException.
    This constructor variant is used when the error message for the specified error code has no parameters and no included information.
    This variant also issues a trace on the CHANNEL_EXCEPTION channel of level LEVEL_ERROR.
    
    Parameters:
    
    errorCode - the error code
    
    nestedThrowable - the Throwable that led to this IfsException
    
    object - the Traceable associated with the IfsException
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable and no included information.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    (Published)
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters,
                    Traceable object)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable and no included information.
    This variant also issues a trace on the CHANNEL_EXCEPTION channel of level LEVEL_ERROR.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    object - the Traceable associated with the IfsException
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable and the error message for the specified error code has no parameters, and no included information.
    
    Parameters:
    
    errorCode - the error code
    
    (Published)
  - IfsException
```
public IfsException(int errorCode,
                    Traceable object)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable and the error message for the specified error code has no parameters, and no included information.
    This variant also issues a trace on the CHANNEL_EXCEPTION channel of level LEVEL_ERROR.
    
    Parameters:
    
    errorCode - the error code
    
    object - the Traceable associated with the IfsException
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    String infoDescription,
                    Object info)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable and the error message for the specified error code has no parameters.
    
    Parameters:
    
    errorCode - the error code
    
    infoDescription - description of the exception information
    
    info - the exception information
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    Object[] parameters,
                    String infoDescription,
                    Object info)
```
    Constructs an IfsException.
    This constructor variant is used when the IfsException has no nested Throwable.
    
    Parameters:
    
    errorCode - the error code
    
    parameters - an array of Objects to be substituted into the resource bundle message using using java.text.MessageFormat to produce a localized error message
    
    infoDescription - description of the exception information
    
    info - the exception information
    
    (Unpublished)
  - IfsException
```
public IfsException(int errorCode,
                    Throwable nestedThrowable,
                    String infoDescription,
                    Object info)
```
    Constructs an IfsException.
    This constructor variant is used when the error message for the specified error code has no parameters.
    
    Parameters:
    
    errorCode - the error code
    
    nestedThrowable - the Throwable that led to this IfsException
    
    infoDescription - description of the exception information
    
    info - the exception information
    
    (Unpublished)
- Method Detail
  - getErrorCode
```
public final int getErrorCode()
```
    Gets the error code of this IfsException.
    
    Returns:
    
    the error code
    
    (Published)
  - getParameters
```
public final Object[] getParameters()
```
    Gets the parameter values for the error message.
    
    Returns:
    
    an array of parameter values
    
    (Published)
  - getInfoDescription
```
public final String getInfoDescription()
```
    Gets the description of the exception information.
    
    Returns:
    
    the error code
    
    (Unpublished)
  - getInfo
```
public final Object getInfo()
```
    Gets the exception information.
    
    Returns:
    
    the error code
    
    (Unpublished)
  - getNestedThrowable
```
public final Throwable getNestedThrowable()
```
    Gets the Throwable that led to this IfsException.
    
    Returns:
    
    the nested Throwable, or null if this is the originating exception
    
    (Published)
  - getNestedException
```
@Deprecated
public final Exception getNestedException()
```
    Deprecated. iFS 9.0 use getNestedThrowable
    
    Gets the Exception that led to this IfsException.
    
    Returns:
    
    the nested Exception, or null if either this is the originating exception or the nested Throwable is not an Exception
    
    (Unpublished)
  - getNestedIfsException
```
public final IfsException getNestedIfsException(int errorCode)
```
    Gets a nested IfsException that matches the specified error code.
    
    Parameters:
    
    errorCode - the specified error code
    
    Returns:
    
    the nested IfsException, or null if the specified error code is not nested below this IfsException
    
    (Published)
  - containsErrorCode
```
public final boolean containsErrorCode(int errorCode)
```
    Gets whether this IfsException or any nested IfsExceptions have the specified error code.
    
    Parameters:
    
    errorCode - the error code of interest
    
    Returns:
    
    whether this IfsException or any nested IfsExceptions have the specified error code
    
    (Published)
  - printStackTrace
```
public void printStackTrace()
```
    Prints the stack trace of this IfsException to the standard error stream, using US English.
    
    Overrides:
    
    printStackTrace in class Throwable
    
    (Published)
  - printStackTrace
```
public void printStackTrace(PrintStream stream)
```
    Prints the stack trace of this IfsException to the specified PrintStream, using US English.
    
    Overrides:
    
    printStackTrace in class Throwable
    
    Parameters:
    
    stream - the PrintStream
    
    (Published)
  - printStackTrace
```
public void printStackTrace(PrintWriter writer)
```
    Prints the stack trace of this IfsException to the specified PrintWriter, using US English.
    
    Overrides:
    
    printStackTrace in class Throwable
    
    Parameters:
    
    writer - the PrintWriter
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace()
```
    Prints the stack trace of this IfsException to the standard error stream, using the default locale of the Java VM.
    The default locale of the Java virtual machine is determined by invoking the java.util.Locale.getDefault method.
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintStream stream)
```
    Prints the stack trace of this IfsException to the specified PrintStream, using the default locale of the Java VM.
    The default locale of the Java virtual machine is determined by invoking the java.util.Locale.getDefault method.
    
    Parameters:
    
    stream - the PrintStream
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintWriter writer)
```
    Prints the stack trace of this IfsException to the specified PrintWriter, using the default locale of the Java VM.
    The default locale of the Java virtual machine is determined by invoking the java.util.Locale.getDefault method.
    
    Parameters:
    
    writer - the PrintWriter
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(LibrarySessionInterface session)
```
    Prints the stack trace of this IfsException to the standard error stream, using the locale of the specified session's Localizer.
    
    Parameters:
    
    session - the session
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintStream stream,
                                     LibrarySessionInterface session)
```
    Prints the stack trace of this IfsException to the specified PrintStream, using the locale of the specified session's Localizer.
    
    Parameters:
    
    stream - the PrintStream
    
    session - the session
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintWriter writer,
                                     LibrarySessionInterface session)
```
    Prints the stack trace of this IfsException to the specified PrintWriter, using the locale of the specified session's Localizer.
    
    Parameters:
    
    writer - the PrintWriter
    
    session - the session
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(Localizer localizer)
```
    Prints the stack trace of this IfsException to the standard error stream, using the locale of the specified Localizer.
    
    Parameters:
    
    localizer - the Localizer
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintStream stream,
                                     Localizer localizer)
```
    Prints the stack trace of this IfsException to the specified PrintStream, using the locale of the specified Localizer.
    
    Parameters:
    
    stream - the PrintStream
    
    localizer - the Localizer
    
    (Published)
  - printLocalizedStackTrace
```
public void printLocalizedStackTrace(PrintWriter writer,
                                     Localizer localizer)
```
    Prints the stack trace of this IfsException to the specified PrintWriter, using the locale of the specified Localizer.
    
    Parameters:
    
    writer - the PrintWriter
    
    localizer - the Localizer
    
    (Published)
  - getMessage
```
public String getMessage()
```
    Gets the US English description of this IfsException.
    
    Overrides:
    
    getMessage in class Throwable
    
    Returns:
    
    the error message
    
    (Published)
  - getLocalizedMessage
```
public String getLocalizedMessage()
```
    Gets the description of this IfsException for the default locale of the Java VM.
    The default locale of the Java virtual machine is determined by invoking the java.util.Locale.getDefault method.
    
    Overrides:
    
    getLocalizedMessage in class Throwable
    
    Returns:
    
    the error message
    
    (Published)
  - getLocalizedMessage
```
public String getLocalizedMessage(LibrarySessionInterface session)
```
    Gets the description of this IfsException for the locale of the specified session's Localizer.
    
    Parameters:
    
    session - the session
    
    Returns:
    
    the error message
    
    (Published)
  - getLocalizedMessage
```
public String getLocalizedMessage(Localizer localizer)
```
    Gets the description of this IfsException for the locale of the specified Localizer.
    
    Parameters:
    
    localizer - the Localizer
    
    Returns:
    
    the error message
    
    (Published)
  - toString
```
public String toString()
```
    Represents this IfsException as a US English string.
    
    Overrides:
    
    toString in class Throwable
    
    Returns:
    
    a string representation of this IfsException
    
    (Published)
  - toLocalizedString
```
public String toLocalizedString()
```
    Represents this IfsException as a localized string, using the default locale of the Java VM.
    The default locale of the Java virtual machine is determined by invoking the java.util.Locale.getDefault method.
    
    Returns:
    
    a string representation of this IfsException
    
    (Published)
  - toLocalizedString
```
public String toLocalizedString(LibrarySessionInterface session)
```
    Represents this IfsException as a localized string, using the locale of the specified session's Localizer.
    
    Parameters:
    
    session - the session
    
    Returns:
    
    a string representation of this IfsException
    
    (Published)
  - toLocalizedString
```
public String toLocalizedString(Localizer localizer)
```
    Represents this IfsException as a localized string, using the locale of the specified Localizer.
    
    Parameters:
    
    localizer - the Localizer
    
    Returns:
    
    a string representation of this IfsException
    
    (Published)
  - setVerboseMessage
```
public static final void setVerboseMessage(boolean verbose)
```
    Specifies whether toString and toLocalizedString produces verbose messages.
    Verbose messages include the messages of nested Throwables.
    Verbose messages are produced by default.
    
    Parameters:
    
    verbose - whether the messages are verbose
    
    (Published)
  - isVerboseMessage
```
public static final boolean isVerboseMessage()
```
    Gets whether toString and toLocalizedString produces verbose messages.
    Verbose messages include the messages of nested Throwables.
    Verbose messages are produced by default.
    
    Returns:
    
    whether the messages are verbose
    
    (Published)
  - fillInRemoteStackTrace
```
public final IfsException fillInRemoteStackTrace()
```
    Sets the remote backtrace of this IfsException.
    
    Returns:
    
    an IfsException with a remote backtrace
    
    (Unpublished)
  - fillInRemoteStackTrace
```
public final void fillInRemoteStackTrace(String backtrace)
```
    Fills in the remote backtrace of this IfsException to the specified string.
    
    Parameters:
    
    backtrace - the backtrace
    
    (Unpublished)
  - ignoreObjectNotFoundException
```
public void ignoreObjectNotFoundException()
                                   throws IfsException
```
    Re-throw the target exception unless it reflects an "object not found" condition.
    
    Throws:
    
    IfsException - if the target exception is for any condition other than bject not found; re-throws specified exception

Class IfsException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

m_ErrorCode

m_Parameters

m_InfoDescription

m_Info

m_NestedThrowable

m_OriginatingThrowable

m_RemoteBacktrace

s_VerboseMessage

Constructor Detail

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

IfsException

Method Detail

getErrorCode

getParameters

getInfoDescription

getInfo

getNestedThrowable

getNestedException

getNestedIfsException

containsErrorCode

printStackTrace

printStackTrace

printStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

printLocalizedStackTrace

getMessage

getLocalizedMessage

getLocalizedMessage

getLocalizedMessage

toString

toLocalizedString

toLocalizedString

toLocalizedString

setVerboseMessage

isVerboseMessage

fillInRemoteStackTrace

fillInRemoteStackTrace

ignoreObjectNotFoundException