com.phloc.commons.codec

Interface IStringCodec

All Superinterfaces:

IByteArrayDecoder, IByteArrayEncoder, ICodec, IDecoder<byte[]>, IEncoder<byte[]>

All Known Implementing Classes:

AbstractRFC1522Codec, QuotedPrintableCodec, RFC1522BCodec, RFC1522QCodec, URLCodec

public interface IStringCodec
extends ICodec

Interface for a single encoder + decoder that is based on a String.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
String	decodeText(String sEncoded) Decode the passed string.
String	encodeText(String sDecoded) Encode the passed string.
Charset	getCharset() Gets the default charset name used for string decoding and encoding.

Methods inherited from interface com.phloc.commons.codec.ICodec

decode, encode

Methods inherited from interface com.phloc.commons.codec.IByteArrayEncoder

encode

Methods inherited from interface com.phloc.commons.codec.IByteArrayDecoder

decode

Method Detail

getCharset

@Nonnull
Charset getCharset()

Gets the default charset name used for string decoding and encoding.

Returns:

the default charset. Never null.

encodeText

@Nullable
String encodeText(@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:

EncoderException - In case something goes wrong

decodeText

@Nullable
String decodeText(@Nullable
                         String sEncoded)

Decode the passed string.

Parameters:

sEncoded - The string to be decoded. May be null.

Returns:

null if the input string is null.

Throws:

DecoderException - in case something goes wrong