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

Interface Style

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

  • Method Details

    • encode

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

    • style

      default Style style(char ch) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      Returns:
      this writer
      Throws:
      IOException

    • style

      default Style style(char[] cbuf) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      Returns:
      this writer
      Throws:
      IOException

    • style

      default Style style(char[] cbuf, int offset, int len) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      Returns:
      this writer
      Throws:
      IOException

    • style

      default Style style(CharSequence csq) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      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

    • style

      default Style style(CharSequence csq, int start, int end) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      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

    • style

      default Style style(Object style) throws IOException
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      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

    • style

      default <Ex extends Throwable> Style style(IOSupplierE<?,Ex> style) throws IOException, Ex
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      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

    • style

      default <Ex extends Throwable> Style style(StyleWritable<Ex> style) throws IOException, Ex
      Writes the given CSS stylesheet with proper encoding.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      Does not perform any translation markups.

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

    • style

      default StyleWriter style() throws IOException
      Writes the given CSS stylesheet with proper encoding. This is well suited for use in a try-with-resources block.

      Adds prefixes and suffixes by media type, such as <style>…</style>.

      Does not perform any translation markups.

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