Enum ProtocolVersion

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ProtocolVersion>

    public enum ProtocolVersion
    extends java.lang.Enum<ProtocolVersion>
    Enum representing the supported PostgreSQL protocol versions.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      v3_0
      Protocol version 3.0
      v3_2
      Protocol version 3.2
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ProtocolVersion fromMajorMinor​(int major, int minor)  
      int getMajor()
      Gets the major version number.
      int getMinor()
      Gets the minor version number.
      java.lang.String toString()  
      static ProtocolVersion valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ProtocolVersion[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static ProtocolVersion[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ProtocolVersion c : ProtocolVersion.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ProtocolVersion valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • fromMajorMinor

        public static ProtocolVersion fromMajorMinor​(int major,
                                                     int minor)
                                              throws java.sql.SQLException
        Parameters:
        major - (int): The major version number of the protocol.
        minor - (int): The minor version number of the protocol.
        Returns:
        A `ProtocolVersion` enum value representing the specified protocol version.
        Throws:
        java.sql.SQLException - if the requested protocol version is not supported. Performs a simple validation check to ensure that only supported protocol versions are used. Currently, the PostgreSQL JDBC driver only supports protocol versions 3.0 and 3.2.
      • getMajor

        public int getMajor()
        Gets the major version number.
        Returns:
        the major version number
      • getMinor

        public int getMinor()
        Gets the minor version number.
        Returns:
        the minor version number
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<ProtocolVersion>