Top Description Fields Constructors Methods
org.postgresql.core.v3

pack-priv Class Portal

extends Object
implements ResultCursor
Class Inheritance
All Implemented Interfaces
org.postgresql.core.ResultCursor
Imports
org.postgresql.core.ResultCursor, org.checkerframework.checker.nullness.qual.Nullable, java.lang.ref.PhantomReference, java.nio.charset.StandardCharsets
V3 ResultCursor implementation in terms of backend Portals. This holds the state of a single Portal. We use a PhantomReference managed by our caller to handle resource cleanup.
Author
Oliver Jowett ([email protected])

Field Summary

Modifier and TypeField and Description
private @Nullable PhantomReference<?>
cleanupRef

private final byte[]
encodedName

private final String
portalName

private final @Nullable SimpleQuery
query

Constructor Summary

AccessConstructor and Description
pack-priv
Portal(@Nullable SimpleQuery query, String portalName)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements org.postgresql.core.ResultCursor.close.

Close this cursor.

pack-priv byte[]
getEncodedPortalName()

pack-priv String
getPortalName()

pack-priv @Nullable SimpleQuery
getQuery()

pack-priv void
setCleanupRef(PhantomReference<?> cleanupRef)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

cleanupRefback to summary
private @Nullable PhantomReference<?> cleanupRef
encodedNameback to summary
private final byte[] encodedName
portalNameback to summary
private final String portalName
queryback to summary
private final @Nullable SimpleQuery query

Constructor Detail

Portalback to summary
pack-priv Portal(@Nullable SimpleQuery query, String portalName)

Method Detail

closeback to summary
public void close()

Implements org.postgresql.core.ResultCursor.close.

Doc from org.postgresql.core.ResultCursor.close.

Close this cursor. This may not immediately free underlying resources but may make it happen more promptly. Closed cursors should not be passed to QueryExecutor methods.

Annotations
@Override
getEncodedPortalNameback to summary
pack-priv byte[] getEncodedPortalName()
getPortalNameback to summary
pack-priv String getPortalName()
getQueryback to summary
pack-priv @Nullable SimpleQuery getQuery()
setCleanupRefback to summary
pack-priv void setCleanupRef(PhantomReference<?> cleanupRef)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override