io.asyncer.r2dbc.mysql

Class ParameterWriter

java.lang.Object

java.io.Writer

io.asyncer.r2dbc.mysql.ParameterWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public abstract class ParameterWriter
extends Writer

A writer for MySqlParameters of parametrized statements with text-based protocol.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
ParameterWriter()

Method Summary

Modifier and Type	Method and Description
abstract ParameterWriter	append(char c) Writes a character as a string.
abstract ParameterWriter	append(@Nullable CharSequence csq) Writes a CharSequence as a string.
abstract ParameterWriter	append(@Nullable CharSequence csq, int start, int end) Writes a subsequence of a CharSequence as a string.
void	close() NOOP.
void	flush() NOOP.
abstract void	startHex() Mark the following parameter is a hex byte buffer, replace the placeholder with x'.
abstract void	startString() Mark the following parameter is a string, prepare and wrap the placeholder with '.
abstract void	write(@Nullable char[] c) Writes a character array as a string.
abstract void	write(@Nullable char[] c, int off, int len) Writes a subsequence of a character array as a string.
abstract void	write(int c) Writes a character as a string.
abstract void	write(@Nullable String str) Writes a String.
abstract void	write(@Nullable String str, int off, int len) Writes a substring of a String.
abstract void	writeBigDecimal(BigDecimal value) Writes a value of BigDecimal to current parameter.
abstract void	writeBigInteger(BigInteger value) Writes a value of BigInteger to current parameter.
abstract void	writeBinary(boolean bit) Writes a value of binary data to current parameter with binary encoding.
abstract void	writeDouble(double value) Writes a value of double to current parameter.
abstract void	writeFloat(float value) Writes a value of float to current parameter.
abstract void	writeHex(byte[] bytes) Writes a value of binary data to current parameter with hex encoding.
abstract void	writeHex(ByteBuffer buffer) Writes a value of binary data to current parameter with hex encoding.
abstract void	writeHex(long bits) Writes a value of binary data to current parameter with hex encoding.
abstract void	writeInt(int value) Writes a value of int to current parameter.
abstract void	writeLong(long value) Writes a value of long to current parameter.
abstract void	writeNull() Writes a null value to current parameter, nothing else can be written before or after this.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterWriter

public ParameterWriter()

Method Detail

writeNull

public abstract void writeNull()

Writes a null value to current parameter, nothing else can be written before or after this.

Throws:

IllegalStateException - if parameters filled, or something was written before that.

writeInt

public abstract void writeInt(int value)

Writes a value of int to current parameter. If current mode is string mode, it will write as a string like write(String.valueOf(value)). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of int.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before numeric.

writeLong

public abstract void writeLong(long value)

Writes a value of long to current parameter. If current mode is string mode, it will write as a string like write(String.valueOf(value)). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of long.

Throws:

IllegalStateException - if parameters filled, or something was written before that numeric.

writeBigInteger

public abstract void writeBigInteger(BigInteger value)

Writes a value of BigInteger to current parameter. If current mode is string mode, it will write as a string like write(value.toString()). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of BigInteger.

Throws:

IllegalArgumentException - the value is null.

IllegalStateException - if parameters filled, or something was written before that numeric.

writeFloat

public abstract void writeFloat(float value)

Writes a value of float to current parameter. If current mode is string mode, it will write as a string like write(String.valueOf(value)). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of float.

Throws:

IllegalStateException - if parameters filled, or something was written before that numeric.

writeDouble

public abstract void writeDouble(double value)

Writes a value of double to current parameter. If current mode is string mode, it will write as a string like write(String.valueOf(value)). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of double.

Throws:

IllegalStateException - if parameters filled, or something was written before that numeric.

writeBigDecimal

public abstract void writeBigDecimal(BigDecimal value)

Writes a value of BigDecimal to current parameter. If current mode is string mode, it will write as a string like write(value.toString()). If it write as a numeric, nothing else can be written before or after this.

Parameters:

value - the value of BigDecimal.

Throws:

IllegalArgumentException - the value is null.

IllegalStateException - if parameters filled, or something was written before that numeric.

writeBinary

public abstract void writeBinary(boolean bit)

Writes a value of binary data to current parameter with binary encoding. Only binary encoding can be written before or after this.

Parameters:

bit - the binary data.

Throws:

IllegalStateException - if parameters filled, or other encoding was written before that.

writeHex

public abstract void writeHex(ByteBuffer buffer)

Writes a value of binary data to current parameter with hex encoding. Only hex encoding can be written before or after this.

Note: to write binary data with text protocol, Hex or Base64 encoding should be used. And MySQL 5.5 Community Edition does not support Base64.

Parameters:

buffer - the binary data.

Throws:

IllegalArgumentException - if buffer is null.

IllegalStateException - if parameters filled, or other encoding was written before that.

writeHex

public abstract void writeHex(byte[] bytes)

Writes a value of binary data to current parameter with hex encoding. Only hex encoding can be written before or after this.

Note: write a binary data with text protocol need use Hex or Base64 encoding. And MySQL 5.5 Community Edition does not support Base64.

Parameters:

bytes - the binary data.

Throws:

IllegalArgumentException - if bytes is null.

IllegalStateException - if parameters filled, or other encoding was written before that.

writeHex

public abstract void writeHex(long bits)

Writes a value of binary data to current parameter with hex encoding. Only hex encoding can be written before or after this.

Note: write a binary data with text protocol need use Hex or Base64 encoding. And MySQL 5.5 Community Edition does not support Base64.

Parameters:

bits - the binary data bitmap, see also Long.toHexString(long).

Throws:

IllegalArgumentException - if bytes is null.

IllegalStateException - if parameters filled, or other encoding was written before that.

startString

public abstract void startString()

Mark the following parameter is a string, prepare and wrap the placeholder with '. If this writer has been written a string value or marked as string mode, it will do nothing. Only string (or stringify numeric) can be written before this.

It is useful for a string parameter starts with a number, like date or time. Also be used by reactive streaming string parameter, like Clob.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before calling.

startHex

public abstract void startHex()

Mark the following parameter is a hex byte buffer, replace the placeholder with x'. If this writer has been written a hex value or marked as hex mode, it will do nothing. Only hex value can be written before this.

It is useful for reactive streaming byte buffer parameter, like Blob.

Throws:

IllegalStateException - if parameters filled, or a non-hex value was written before calling.

write

public abstract void write(int c)

Writes a character as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Overrides:

write in class Writer

Parameters:

c - an int specifying the character.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

append

public abstract ParameterWriter append(char c)

Writes a character as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

c - the character.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

append

public abstract ParameterWriter append(@Nullable
                                       @Nullable CharSequence csq)

Writes a CharSequence as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

csq - the CharSequence.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

append

public abstract ParameterWriter append(@Nullable
                                       @Nullable CharSequence csq,
                                       int start,
                                       int end)

Writes a subsequence of a CharSequence as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Parameters:

csq - the CharSequence.

start - index of the first position in the subsequence of the csq.

end - index of the sentinel position in the subsequence of the csq.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

write

public abstract void write(@Nullable
                           @Nullable String str)

Writes a String. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Overrides:

write in class Writer

Parameters:

str - the String.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

write

public abstract void write(@Nullable
                           @Nullable String str,
                           int off,
                           int len)

Writes a substring of a String. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Overrides:

write in class Writer

Parameters:

str - the String.

off - index of the first position in the substring of the str.

len - length of the substring.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

write

public abstract void write(@Nullable
                           @Nullable char[] c)

Writes a character array as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Overrides:

write in class Writer

Parameters:

c - the character array.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

write

public abstract void write(@Nullable
                           @Nullable char[] c,
                           int off,
                           int len)

Writes a subsequence of a character array as a string. Only string (or stringify numeric) can be written before this. All character in string mode will be automatically escaped.

Specified by:

write in class Writer

Parameters:

c - the character array.

off - index of the first position in the subsequence of the c.

len - length of the subsequence.

Throws:

IllegalStateException - if parameters filled, or a non-string value was written before that.

flush

public final void flush()

NOOP. This writer is a buffer writer.

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public final void close()

NOOP. This writer is a buffer writer.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer