Module com.aoapps.encoding
Package com.aoapps.encoding

Interface Psql

All Superinterfaces:
Encode
All Known Implementing Classes:
PsqlWriter, TextWriter
@ThreadSafe public interface Psql extends Encode
Encodes psql command input for safe output.
Author:
AO Industries, Inc.

  • Method Summary

    Modifier and Type
    Method
    Description
    MediaWriter
    encode(MediaType contentType)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default Psql
    encode(MediaType contentType, char ch)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default Psql
    encode(MediaType contentType, char[] cbuf)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default Psql
    encode(MediaType contentType, char[] cbuf, int offset, int len)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default <Ex extends Throwable>
    Psql
    encode(MediaType contentType, MediaWritable<Ex> content)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default <Ex extends Throwable>
    Psql
    encode(MediaType contentType, IOSupplierE<?,Ex> content)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    Psql
    encode(MediaType contentType, CharSequence csq)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    Psql
    encode(MediaType contentType, CharSequence csq, int start, int end)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    Psql
    encode(MediaType contentType, Object content)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default PsqlWriter
    psql()
    Writes the given psql command input with proper encoding.
    default Psql
    psql(char ch)
    Writes the given psql command input with proper encoding.
    default Psql
    psql(char[] cbuf)
    Writes the given psql command input with proper encoding.
    default Psql
    psql(char[] cbuf, int offset, int len)
    Writes the given psql command input with proper encoding.
    default <Ex extends Throwable>
    Psql
    psql(PsqlWritable<Ex> psql)
    Writes the given psql command input with proper encoding.
    default <Ex extends Throwable>
    Psql
    psql(IOSupplierE<?,Ex> psql)
    Writes the given psql command input with proper encoding.
    default Psql
    psql(CharSequence csq)
    Writes the given psql command input with proper encoding.
    default Psql
    psql(CharSequence csq, int start, int end)
    Writes the given psql command input with proper encoding.
    default Psql
    psql(Object psql)
    Writes the given psql command input with proper encoding.

  • Method Details

    • encode

      @Deprecated default Psql encode(MediaType contentType, char ch) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated default Psql encode(MediaType contentType, char[] cbuf) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated default Psql encode(MediaType contentType, char[] cbuf, int offset, int len) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated Psql encode(MediaType contentType, CharSequence csq) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated Psql encode(MediaType contentType, CharSequence csq, int start, int end) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated Psql encode(MediaType contentType, Object content) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Specified by:
      encode in interface Encode
      Returns:
      this writer
      Throws:
      IOException

    • encode

      @Deprecated default <Ex extends Throwable> Psql encode(MediaType contentType, IOSupplierE<?,Ex> content) throws IOException, Ex
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Specified by:
      encode in interface Encode
      Type Parameters:
      Ex - An arbitrary exception type that may be thrown
      Returns:
      this writer
      Throws:
      IOException
      Ex

    • encode

      @Deprecated default <Ex extends Throwable> Psql encode(MediaType contentType, MediaWritable<Ex> content) throws IOException, Ex
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding.

      Adds prefixes and suffixes by media type, such as "…".

      Does not perform any translation markups.

      Specified by:
      encode in interface Encode
      Type Parameters:
      Ex - An arbitrary exception type that may be thrown
      Returns:
      this writer
      Throws:
      IOException
      Ex

    • encode

      @Deprecated MediaWriter encode(MediaType contentType) throws IOException
      Deprecated.
      Encoding of arbitrary content types is not expected since all supported types have per-type methods.
      Encodes the given nested type with proper encoding. This is well suited for use in a try-with-resources block.

      Adds prefixes and suffixes by media type, such as "…".

      Does not perform any translation markups.

      Specified by:
      encode in interface Encode
      Returns:
      A new writer that may be used for the given content type. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).

      The returned writer will be of the specific subclass of MediaWriter matching contentType (see MediaType.getMediaWriterClass(). This means MediaWriter.getValidMediaInputType() will be contentType.

      Throws:
      IOException

    • psql

      default Psql psql(char ch) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default Psql psql(char[] cbuf) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default Psql psql(char[] cbuf, int offset, int len) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default Psql psql(CharSequence csq) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default Psql psql(CharSequence csq, int start, int end) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default Psql psql(Object psql) throws IOException
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Returns:
      this writer
      Throws:
      IOException

    • psql

      default <Ex extends Throwable> Psql psql(IOSupplierE<?,Ex> psql) throws IOException, Ex
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      If the string is translated, comments will be added giving the translation lookup id to aid in translation of server-translated values.

      Type Parameters:
      Ex - An arbitrary exception type that may be thrown
      Returns:
      this writer
      Throws:
      IOException
      Ex

    • psql

      default <Ex extends Throwable> Psql psql(PsqlWritable<Ex> psql) throws IOException, Ex
      Writes the given psql command input with proper encoding.

      Adds prefixes and suffixes by media type.

      Does not perform any translation markups.

      Type Parameters:
      Ex - An arbitrary exception type that may be thrown
      Returns:
      this writer
      Throws:
      IOException
      Ex

    • psql

      default PsqlWriter psql() throws IOException
      Writes the given psql command input with proper encoding. This is well suited for use in a try-with-resources block.

      Adds prefixes and suffixes by media type.

      Does not perform any translation markups.

      Returns:
      A new writer that may be used for arbitrary psql command input. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).
      Throws:
      IOException