Top Description Fields Constructors Methods
org.postgresql

public final Enum PGEnvironment

extends Enum<PGEnvironment>
Class Inheritance
Imports
org.checkerframework.checker.nullness.qual.Nullable, java.util.HashMap, .Map

Some environment variables are intended to have same meaning as libpq describes here: https://www.postgresql.org/docs/current/libpq-envars.html

Field Summary

Modifier and TypeField and Description
private final @Nullable String
private final String
private final String
public static final PGEnvironment
ORG_POSTGRESQL_PGPASSFILE

Specified location of password file.

public static final PGEnvironment
ORG_POSTGRESQL_PGSERVICEFILE

The connection service resource (file, url) allows connection parameters to be associated with a single service name.

public static final PGEnvironment
PGPASSFILE

Specified location of password file.

public static final PGEnvironment
PGSERVICEFILE

The connection service resource (file, url) allows connection parameters to be associated with a single service name.

public static final PGEnvironment
PGSYSCONFDIR

sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files.

private static final Map<String, PGEnvironment>

Constructor Summary

AccessConstructor and Description
private
PGEnvironment(String name, @Nullable String defaultValue, String description)

Method Summary

Modifier and TypeMethod and Description
public @Nullable String

Returns:

the default value for this parameter or null
getDefaultValue
()

Returns the default value for this parameter.

public String

Returns:

the description for this parameter
getDescription
()

Returns the description for this parameter.

public String

Returns:

the name of the parameter
getName
()

Returns the name of the parameter.

public static PGEnvironment
public static PGEnvironment[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

defaultValueback to summary
private final @Nullable String defaultValue
descriptionback to summary
private final String description
nameback to summary
private final String name

Hides java.lang.Enum.name.

ORG_POSTGRESQL_PGPASSFILEback to summary
public static final PGEnvironment ORG_POSTGRESQL_PGPASSFILE

Specified location of password file.

ORG_POSTGRESQL_PGSERVICEFILEback to summary
public static final PGEnvironment ORG_POSTGRESQL_PGSERVICEFILE

The connection service resource (file, url) allows connection parameters to be associated with a single service name.

PGPASSFILEback to summary
public static final PGEnvironment PGPASSFILE

Specified location of password file.

PGSERVICEFILEback to summary
public static final PGEnvironment PGSERVICEFILE

The connection service resource (file, url) allows connection parameters to be associated with a single service name.

PGSYSCONFDIRback to summary
public static final PGEnvironment PGSYSCONFDIR

sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files.

PROPS_BY_NAMEback to summary
private static final Map<String, PGEnvironment> PROPS_BY_NAME

Constructor Detail

PGEnvironmentback to summary
private PGEnvironment(String name, @Nullable String defaultValue, String description)

Method Detail

getDefaultValueback to summary
public @Nullable String getDefaultValue()

Returns the default value for this parameter.

Returns:@Nullable String

the default value for this parameter or null

getDescriptionback to summary
public String getDescription()

Returns the description for this parameter.

Returns:String

the description for this parameter

getNameback to summary
public String getName()

Returns the name of the parameter.

Returns:String

the name of the parameter

valueOfback to summary
public static PGEnvironment valueOf(String name)
valuesback to summary
public static PGEnvironment[] values()