Package com.helger.commons.codec

Interface ICharArrayEncoder

All Superinterfaces:
IEncoder<char[],char[]>
All Known Subinterfaces:
ICharArrayCodec, ICharArrayStreamEncoder
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 ICharArrayEncoder extends IEncoder<char[],char[]>
Interface for a single encoder of chars.
Since:
9.3.6
Author:
Philip Helger

  • Method Summary

    Modifier and Type
    Method
    Description
    default char[]
    getEncoded(char[] aDecodedBuffer)
    Encode a char array.
    char[]
    getEncoded(char[] aDecodedBuffer, int nOfs, int nLen)
    Encode a char array.
    default char[]
    getEncoded(String sDecoded)
    Encode the passed 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)
      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".
      Parameters:
      nDecodedLen - The decoded length. Always ≥ 0.
      Returns:
      The maximum encoded length. Always ≥ 0.

    • getEncoded

      @Nullable @ReturnsMutableCopy default char[] getEncoded(@Nullable char[] aDecodedBuffer)
      Encode a char array.
      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 char[] getEncoded(@Nullable char[] aDecodedBuffer, @Nonnegative int nOfs, @Nonnegative int nLen)
      Encode a char array.
      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.
      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