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
  • Enum Constant Details

  • 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