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

Interface Sh

All Superinterfaces:
Encode
All Known Implementing Classes:
ShWriter, TextWriter
@ThreadSafe public interface Sh extends Encode
Encodes shell scripts 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 Sh
    encode(MediaType contentType, char ch)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default Sh
    encode(MediaType contentType, char[] cbuf)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default Sh
    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>
    Sh
    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>
    Sh
    encode(MediaType contentType, IOSupplierE<?,Ex> content)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    Sh
    encode(MediaType contentType, CharSequence csq)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    Sh
    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.
    Sh
    encode(MediaType contentType, Object content)
    Deprecated.
    Encoding of arbitrary content types is not expected since all supported types have per-type methods.
    default ShWriter
    sh()
    Writes the given shell script with proper encoding.
    default Sh
    sh(char ch)
    Writes the given shell script with proper encoding.
    default Sh
    sh(char[] cbuf)
    Writes the given shell script with proper encoding.
    default Sh
    sh(char[] cbuf, int offset, int len)
    Writes the given shell script with proper encoding.
    default <Ex extends Throwable>
    Sh
    sh(ShWritable<Ex> sh)
    Writes the given shell script with proper encoding.
    default <Ex extends Throwable>
    Sh
    sh(IOSupplierE<?,Ex> sh)
    Writes the given shell script with proper encoding.
    default Sh
    sh(CharSequence csq)
    Writes the given shell script with proper encoding.
    default Sh
    sh(CharSequence csq, int start, int end)
    Writes the given shell script with proper encoding.
    default Sh
    sh(Object sh)
    Writes the given shell script with proper encoding.

  • Method Details

    • encode

      @Deprecated default Sh 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 Sh 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 Sh 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 Sh 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 Sh 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 Sh 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> Sh 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> Sh 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

    • sh

      default Sh sh(char ch) throws IOException
      Writes the given shell script with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • sh

      default Sh sh(char[] cbuf) throws IOException
      Writes the given shell script with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • sh

      default Sh sh(char[] cbuf, int offset, int len) throws IOException
      Writes the given shell script with proper encoding.

      Adds prefixes and suffixes by media type.

      Returns:
      this writer
      Throws:
      IOException

    • sh

      default Sh sh(CharSequence csq) throws IOException
      Writes the given shell script 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

    • sh

      default Sh sh(CharSequence csq, int start, int end) throws IOException
      Writes the given shell script 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

    • sh

      default Sh sh(Object sh) throws IOException
      Writes the given shell script 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

    • sh

      default <Ex extends Throwable> Sh sh(IOSupplierE<?,Ex> sh) throws IOException, Ex
      Writes the given shell script 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

    • sh

      default <Ex extends Throwable> Sh sh(ShWritable<Ex> sh) throws IOException, Ex
      Writes the given shell script 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

    • sh

      default ShWriter sh() throws IOException
      Writes the given shell script 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 shell script. This writer must be closed for completed calls to MediaEncoder.writeSuffixTo(java.lang.Appendable, boolean).
      Throws:
      IOException