io.r2dbc.postgresql.message.frontend

Class Describe

java.lang.Object

io.r2dbc.postgresql.message.frontend.Describe

All Implemented Interfaces:

FrontendMessage, FrontendMessage.DirectEncoder

public final class Describe
extends Object
implements FrontendMessage, FrontendMessage.DirectEncoder

The Describe message.

Nested Class Summary

Nested classes/interfaces inherited from interface io.r2dbc.postgresql.message.frontend.FrontendMessage

FrontendMessage.DirectEncoder

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNNAMED The unnamed statement or portal.

Constructor Summary

Constructors

Constructor and Description
Describe(String name, ExecutionType type) Creates a new message.

Method Summary

Modifier and Type	Method and Description
void	encode(io.netty.buffer.ByteBuf byteBuf) Encode a message directly by writing its content to a ByteBuf.
Publisher<io.netty.buffer.ByteBuf>	encode(io.netty.buffer.ByteBufAllocator byteBufAllocator) Encode a message into a ByteBuf.
boolean	equals(Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNNAMED

public static final String UNNAMED

The unnamed statement or portal.

See Also:

Constant Field Values

Constructor Detail

Describe

public Describe(String name,
                ExecutionType type)

Creates a new message.

Parameters:

name - The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal)

type - the type to close

Throws:

IllegalArgumentException - if name or type is null

See Also:

UNNAMED

Method Detail

encode

public Publisher<io.netty.buffer.ByteBuf> encode(io.netty.buffer.ByteBufAllocator byteBufAllocator)

Description copied from interface: FrontendMessage

Encode a message into a ByteBuf.

Specified by:

encode in interface FrontendMessage

Parameters:

byteBufAllocator - the byteBufAllocator to use to get a ByteBuf to write into

Returns:

a Publisher that produces the ByteBuf containing the encoded message

encode

public void encode(io.netty.buffer.ByteBuf byteBuf)

Description copied from interface: FrontendMessage.DirectEncoder

Encode a message directly by writing its content to a ByteBuf.

Specified by:

encode in interface FrontendMessage.DirectEncoder

Parameters:

byteBuf - the target ByteBuf to write into

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object