Package com.helger.commons.codec

Interface ICharArrayStreamEncoder

All Superinterfaces:
ICharArrayEncoder, IEncoder<char[],char[]>
All Known Subinterfaces:
ICharArrayCodec
All Known Implementing Classes:
RFC2616Codec
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ICharArrayStreamEncoder extends ICharArrayEncoder
Interface for a single encoder of chars, based on reader/writer.
Author:
Philip Helger

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    encode(char[] aDecodedBuffer, int nOfs, int nLen, Writer aWriter)
    Encode (part of) a char array to an Writer.
    default void
    encode(char[] aDecodedBuffer, Writer aWriter)
    Encode a char array to a Writer.
    default char[]
    getEncoded(char[] aDecodedBuffer)
    Encode a char array.
    default char[]
    getEncoded(char[] aDecodedBuffer, int nOfs, int nLen)
    Encode a char array.
    default char[]
    getEncoded(String sDecoded)
    Encode the passed string.
    default String
    getEncodedAsString(char[] aDecodedBuf)
     
    default String
    getEncodedAsString(char[] aDecodedBuf, int nOfs, int nLen)
     
    default String
    getEncodedAsString(String sDecoded)
    Encode the passed string and return the result as a String.
    default int
    getMaximumEncodedLength(int nDecodedLen)
    Get the maximum encoded length based on the provided decoded length.

  • Method Details

    • getMaximumEncodedLength

      @Nonnegative default int getMaximumEncodedLength(@Nonnegative int nDecodedLen)
      Description copied from interface: ICharArrayEncoder
      Get the maximum encoded length based on the provided decoded length. This is purely for performance reasons. The name of the method would be better called "getMaximumEncodedLength".
      Specified by:
      getMaximumEncodedLength in interface ICharArrayEncoder
      Parameters:
      nDecodedLen - The decoded length. Always ≥ 0.
      Returns:
      The maximum encoded length. Always ≥ 0.

    • encode

      default void encode(@Nullable char[] aDecodedBuffer, @Nonnull @WillNotClose Writer aWriter)
      Encode a char array to a Writer.
      Parameters:
      aDecodedBuffer - The char array to be encoded. May be null.
      aWriter - The writer to write to. May not be null and is NOT closed afterwards!
      Throws:
      EncodeException - In case something goes wrong
      Since:
      9.0.0

    • encode

      void encode(@Nullable char[] aDecodedBuffer, @Nonnegative int nOfs, @Nonnegative int nLen, @Nonnull @WillNotClose Writer aWriter)
      Encode (part of) a char array to an Writer.
      Parameters:
      aDecodedBuffer - The char array to be encoded. May be null.
      nOfs - Offset into the char array to start from.
      nLen - Number of chars starting from offset to consider.
      aWriter - The writer to write to. May not be null and is NOT closed afterwards!
      Throws:
      EncodeException - In case something goes wrong

    • getEncoded

      @Nullable @ReturnsMutableCopy default char[] getEncoded(@Nullable char[] aDecodedBuffer)
      Encode a char array.
      Specified by:
      getEncoded in interface ICharArrayEncoder
      Specified by:
      getEncoded in interface IEncoder<char[],char[]>
      Parameters:
      aDecodedBuffer - The char array to be encoded. May be null.
      Returns:
      The encoded char array or null if the parameter was null.
      Throws:
      EncodeException - In case something goes wrong

    • getEncoded

      @Nullable @ReturnsMutableCopy default char[] getEncoded(@Nullable char[] aDecodedBuffer, @Nonnegative int nOfs, @Nonnegative int nLen)
      Encode a char array.
      Specified by:
      getEncoded in interface ICharArrayEncoder
      Parameters:
      aDecodedBuffer - The char array to be encoded. May be null.
      nOfs - Offset into the char array to start from.
      nLen - Number of chars starting from offset to consider.
      Returns:
      The encoded char array or null if the parameter was null.
      Throws:
      EncodeException - In case something goes wrong

    • getEncoded

      @Nullable @ReturnsMutableCopy default char[] getEncoded(@Nullable String sDecoded)
      Encode the passed string.
      Specified by:
      getEncoded in interface ICharArrayEncoder
      Parameters:
      sDecoded - The string to be encoded. May be null.
      Returns:
      null if the input string is null.
      Throws:
      EncodeException - In case something goes wrong

    • getEncodedAsString

      @Nullable default String getEncodedAsString(@Nullable char[] aDecodedBuf)

    • getEncodedAsString

      @Nullable default String getEncodedAsString(@Nullable char[] aDecodedBuf, @Nonnegative int nOfs, @Nonnegative int nLen)

    • getEncodedAsString

      @Nullable default String getEncodedAsString(@Nullable String sDecoded)
      Encode the passed string and return the result as a String.
      Parameters:
      sDecoded - The string to be encoded. May be null.
      Returns:
      null if the input string is null.
      Throws:
      EncodeException - In case something goes wrong