Module org.firebirdsql.jaybird
Package org.firebirdsql.gds.ng

# Enum Class StatementType

java.lang.Object
java.lang.Enum<StatementType>
org.firebirdsql.gds.ng.StatementType

All Implemented Interfaces:
  `Serializable`, `Comparable<StatementType>`, `Constable`

public enum StatementType extends Enum<StatementType>
Firebird statement types.

Author:
  Mark Rotteveel

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `COMMIT`
  `DDL`
  `DELETE`
  `GET_SEGMENT`
  `INSERT`
  `NONE`
  `PUT_SEGMENT`
  `ROLLBACK`
  `SAVE_POINT`
  `SELECT`
  `SELECT_FOR_UPDATE`
  `SET_GENERATOR`
  `START_TRANSACTION`
  `STORED_PROCEDURE`
  `UPDATE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getStatementTypeCode()`
  `boolean`
  `isTypeWithCursor()`
  Indicates whether this statement type has a cursor.
  `boolean`
  `isTypeWithSingletonResult()`
  Indicates whether this statement type will produce a singleton result.
  `boolean`
  `isTypeWithUpdateCounts()`
  Indicates whether this statement type can produce update counts.
  `static StatementType`
  `valueOf(int statementTypeCode)`
  Gets the enum value matching statementTypeCode.
  `static StatementType`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static StatementType[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

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

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### NONE

    public static final StatementType NONE

  - ### SELECT

    public static final StatementType SELECT

  - ### INSERT

    public static final StatementType INSERT

  - ### UPDATE

    public static final StatementType UPDATE

  - ### DELETE

    public static final StatementType DELETE

  - ### DDL

    public static final StatementType DDL

  - ### GET_SEGMENT

    public static final StatementType GET_SEGMENT

  - ### PUT_SEGMENT

    public static final StatementType PUT_SEGMENT

  - ### STORED_PROCEDURE

    public static final StatementType STORED_PROCEDURE

  - ### START_TRANSACTION

    public static final StatementType START_TRANSACTION

  - ### COMMIT

    public static final StatementType COMMIT

  - ### ROLLBACK

    public static final StatementType ROLLBACK

  - ### SELECT_FOR_UPDATE

    public static final StatementType SELECT_FOR_UPDATE

  - ### SET_GENERATOR

    public static final StatementType SET_GENERATOR

  - ### SAVE_POINT

    public static final StatementType SAVE_POINT

- ## Method Details

  - ### values

    public static StatementType[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static StatementType valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
    Parameters:
      `name` - the name of the enum constant to be returned.
    Returns:
      the enum constant with the specified name
    Throws:
      `IllegalArgumentException` - if this enum class has no constant with the specified name
      `NullPointerException` - if the argument is null

  - ### getStatementTypeCode

    public int getStatementTypeCode()
    Returns:
      Firebird statement type code

  - ### isTypeWithCursor

    public boolean isTypeWithCursor()
    Indicates whether this statement type has a cursor.

    Implementation assumes that this is the same for all Firebird versions.

    Returns:
      `true` statement type has a cursor

  - ### isTypeWithSingletonResult

    public boolean isTypeWithSingletonResult()
    Indicates whether this statement type will produce a singleton result.

    Implementation assumes that this is the same for all Firebird versions.

    Returns:
      `true` statement type will produce a singleton result

  - ### isTypeWithUpdateCounts

    public boolean isTypeWithUpdateCounts()
    Indicates whether this statement type can produce update counts.

    Note that in some cases (e.g. an EXECUTE BLOCK) the update count might only be correct after retrieving all rows.

    Returns:
      `true` of this statement type produces an update count

  - ### valueOf

    public static StatementType valueOf(int statementTypeCode)
    Gets the enum value matching statementTypeCode.
    Parameters:
      `statementTypeCode` - Firebird statement type code
    Returns:
      StatementType value matching statementTypeCode
    Throws:
      `IllegalArgumentException` - If the statementTypeCode matches no enum value