Class QCodec

    • Constructor Detail

      • QCodec

        public QCodec()
        Default constructor.
      • QCodec

        public QCodec​(Charset charset)
        Constructor which allows for the selection of a default Charset.
        Parameters:
        charset - the default string Charset to use.
        Since:
        1.7
        See Also:
        Standard charsets
      • QCodec

        public QCodec​(String charsetName)
        Constructor which allows for the selection of a default Charset.
        Parameters:
        charsetName - the Charset to use.
        Throws:
        UnsupportedCharsetException - If the named Charset is unavailable
        Since:
        1.7 throws UnsupportedCharsetException if the named Charset is unavailable
        See Also:
        Standard charsets
    • Method Detail

      • encode

        public String encode​(String sourceStr,
                             Charset sourceCharset)
                      throws EncoderException
        Encodes a string into its quoted-printable form using the specified Charset. Unsafe characters are escaped.
        Parameters:
        sourceStr - string to convert to quoted-printable form
        sourceCharset - the Charset for sourceStr
        Returns:
        quoted-printable string
        Throws:
        EncoderException - thrown if a failure condition is encountered during the encoding process.
        Since:
        1.7
      • encode

        public String encode​(String sourceStr,
                             String sourceCharset)
                      throws EncoderException
        Encodes a string into its quoted-printable form using the specified Charset. Unsafe characters are escaped.
        Parameters:
        sourceStr - string to convert to quoted-printable form
        sourceCharset - the Charset for sourceStr
        Returns:
        quoted-printable string
        Throws:
        EncoderException - thrown if a failure condition is encountered during the encoding process.
      • encode

        public String encode​(String sourceStr)
                      throws EncoderException
        Encodes a string into its quoted-printable form using the default Charset. Unsafe characters are escaped.
        Specified by:
        encode in interface StringEncoder
        Parameters:
        sourceStr - string to convert to quoted-printable form
        Returns:
        quoted-printable string
        Throws:
        EncoderException - thrown if a failure condition is encountered during the encoding process.
      • decode

        public String decode​(String str)
                      throws DecoderException
        Decodes a quoted-printable string into its original form. Escaped characters are converted back to their original representation.
        Specified by:
        decode in interface StringDecoder
        Parameters:
        str - quoted-printable string to convert into its original form
        Returns:
        original string
        Throws:
        DecoderException - A decoder exception is thrown if a failure condition is encountered during the decode process.
      • encode

        public Object encode​(Object obj)
                      throws EncoderException
        Encodes an object into its quoted-printable form using the default Charset. Unsafe characters are escaped.
        Specified by:
        encode in interface Encoder
        Parameters:
        obj - object to convert to quoted-printable form
        Returns:
        quoted-printable object
        Throws:
        EncoderException - thrown if a failure condition is encountered during the encoding process.
      • decode

        public Object decode​(Object obj)
                      throws DecoderException
        Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original representation.
        Specified by:
        decode in interface Decoder
        Parameters:
        obj - quoted-printable object to convert into its original form
        Returns:
        original object
        Throws:
        DecoderException - Thrown if the argument is not a String. Thrown if a failure condition is encountered during the decode process.
      • getCharset

        public Charset getCharset()
        Gets the default Charset name used for string decoding and encoding.
        Returns:
        the default Charset name
        Since:
        1.7
      • getDefaultCharset

        public String getDefaultCharset()
        Gets the default Charset name used for string decoding and encoding.
        Returns:
        the default Charset name
      • isEncodeBlanks

        public boolean isEncodeBlanks()
        Tests if optional transformation of SPACE characters is to be used
        Returns:
        true if SPACE characters are to be transformed, false otherwise
      • setEncodeBlanks

        public void setEncodeBlanks​(boolean b)
        Defines whether optional transformation of SPACE characters is to be used
        Parameters:
        b - true if SPACE characters are to be transformed, false otherwise