Package org.jdbi.v3.postgres

Class PostgresTypes

java.lang.Object

org.jdbi.v3.postgres.PostgresTypes

All Implemented Interfaces:

JdbiConfig<PostgresTypes>

public class PostgresTypes
extends Object
implements JdbiConfig<PostgresTypes>

Handler for PostgreSQL custom types.

Field Summary

Fields

Modifier and Type	Field	Description
private PgLobApi	lob
private ConfigRegistry	registry
private final Map<Class<? extends org.postgresql.util.PGobject>,String>	types

Constructor Summary

Constructors

Modifier	Constructor	Description
	PostgresTypes()
private	PostgresTypes(PostgresTypes that)

Method Summary

Modifier and Type	Method	Description
(package private) void	addTypesToConnection(org.postgresql.PGConnection connection)	Add handler for each registered PostgreSQL custom type
PostgresTypes	createCopy()	Returns a copy of this configuration object.
PgLobApi	getLobApi()	Provide access to Large Object streaming via Postgres specific API.
PostgresTypes	registerCustomType(Class<? extends org.postgresql.util.PGobject> clazz, String typeName)	Register a Postgres custom type.
(package private) PostgresTypes	setLobApi(PgLobApi newLob)
void	setRegistry(ConfigRegistry registry)	The registry will inject itself into the configuration object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

types

private final Map<Class<? extends org.postgresql.util.PGobject>,String> types

registry

private ConfigRegistry registry

lob

private PgLobApi lob

Constructor Details

PostgresTypes

public PostgresTypes()

PostgresTypes

private PostgresTypes(PostgresTypes that)

Method Details

setRegistry

public void setRegistry(ConfigRegistry registry)

Description copied from interface: JdbiConfig

The registry will inject itself into the configuration object. This can be useful if you need to look up dependencies. You will get a new registry after being copied.

Specified by:

setRegistry in interface JdbiConfig<PostgresTypes>

Parameters:

registry - the registry that owns this configuration object

registerCustomType

public PostgresTypes registerCustomType(Class<? extends org.postgresql.util.PGobject> clazz,
 String typeName)

Register a Postgres custom type.

Parameters:

clazz - the class implementing the Java representation of the custom type; must extend PGobject.

typeName - the Postgres custom type name

setLobApi

PostgresTypes setLobApi(PgLobApi newLob)

getLobApi

public PgLobApi getLobApi()

Provide access to Large Object streaming via Postgres specific API.

Returns:

the postgres large object api

addTypesToConnection

void addTypesToConnection(org.postgresql.PGConnection connection)

Add handler for each registered PostgreSQL custom type

Parameters:

connection - connection on which to add all registered PostgreSQL custom types

createCopy

public PostgresTypes createCopy()

Description copied from interface: JdbiConfig

Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.

Specified by:

createCopy in interface JdbiConfig<PostgresTypes>

Returns:

a copy of this configuration object.