org.firebirdsql.gds

## Class GDSExceptionHelper

- java.lang.Object
- - org.firebirdsql.gds.GDSExceptionHelper

-     public class GDSExceptionHelper
      extends java.lang.Object

  This class returns messages for the specified error code.

  It loads all messages during the class initialization and keeps messages in the static `java.util.Properties` variable.

  Version:
    1.0
  Author:
    David Jencks, Roman Rokytskyy, Blas Rodriguez Somoza, Mark Rotteveel

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `GDSExceptionHelper.GDSMessage` This class wraps message template obtained from isc_error_msg.properties file and allows to set parameters to the message.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GDSExceptionHelper()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static GDSExceptionHelper.GDSMessage` | `getMessage(int code)` This method returns a message for the specified error code.
    `static java.lang.String` | `getSQLState(int code)` Get the SQL state for the specified error code.
    `static java.lang.String` | `getSQLState(int code, java.lang.String defaultSQLState)` Get the SQL state for the specified error code.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### GDSExceptionHelper

          public GDSExceptionHelper()

  - ### Method Detail

    - #### getMessage

          public static GDSExceptionHelper.GDSMessage getMessage(int code)

      This method returns a message for the specified error code.
      Parameters:
        `code` - Firebird error code
      Returns:
        instance of `GDSExceptionHelper.GDSMessage` class where you can set desired parameters.

    - #### getSQLState

          public static java.lang.String getSQLState(int code)

      Get the SQL state for the specified error code.
      Parameters:
        `code` - Firebird error code
      Returns:
        SQL state for the Firebird error code, "HY000" if nothing found.

    - #### getSQLState

          public static java.lang.String getSQLState(int code,
                                     java.lang.String defaultSQLState)

      Get the SQL state for the specified error code.
      Parameters:
        `code` - Firebird error code
        `defaultSQLState` - The default SQLState to return
      Returns:
        SQL state for the Firebird error code, or `defaultSQLState` if nothing found.

Copyright © 2001-2021 Jaybird (Firebird JDBC/JCA) team. All rights reserved.