Enum PGEnvironment

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

    public enum PGEnvironment
    extends java.lang.Enum<PGEnvironment>
    Some environment variables are intended to have same meaning as libpq describes here: https://www.postgresql.org/docs/current/libpq-envars.html
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ORG_POSTGRESQL_PGPASSFILE
      Specified location of password file.
      ORG_POSTGRESQL_PGSERVICEFILE
      The connection service resource (file, url) allows connection parameters to be associated with a single service name.
      PGPASSFILE
      Specified location of password file.
      PGSERVICEFILE
      The connection service resource (file, url) allows connection parameters to be associated with a single service name.
      PGSYSCONFDIR
      sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultValue()
      Returns the default value for this parameter.
      java.lang.String getDescription()
      Returns the description for this parameter.
      java.lang.String getName()
      Returns the name of the parameter.
      static PGEnvironment valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PGEnvironment[] 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, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • ORG_POSTGRESQL_PGPASSFILE

        public static final PGEnvironment ORG_POSTGRESQL_PGPASSFILE
        Specified location of password file.
      • PGPASSFILE

        public static final PGEnvironment PGPASSFILE
        Specified location of password file.
      • ORG_POSTGRESQL_PGSERVICEFILE

        public static final PGEnvironment ORG_POSTGRESQL_PGSERVICEFILE
        The connection service resource (file, url) allows connection parameters to be associated with a single service name.
      • PGSERVICEFILE

        public static final PGEnvironment PGSERVICEFILE
        The connection service resource (file, url) allows connection parameters to be associated with a single service name.
      • PGSYSCONFDIR

        public static final PGEnvironment PGSYSCONFDIR
        sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files.
    • Method Detail

      • values

        public static PGEnvironment[] 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 (PGEnvironment c : PGEnvironment.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PGEnvironment 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
      • getName

        public java.lang.String getName()
        Returns the name of the parameter.
        Returns:
        the name of the parameter
      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns the default value for this parameter.
        Returns:
        the default value for this parameter or null
      • getDescription

        public java.lang.String getDescription()
        Returns the description for this parameter.
        Returns:
        the description for this parameter