org.apache.commons.codec
Interface StringEncoder

All Superinterfaces:

Encoder

All Known Implementing Classes:

AbstractCaverphone, BCodec, BeiderMorseEncoder, Caverphone, Caverphone1, Caverphone2, ColognePhonetic, DoubleMetaphone, Metaphone, Nysiis, QCodec, QuotedPrintableCodec, RefinedSoundex, Soundex, URLCodec

public interface StringEncoder
extends Encoder

Defines common encoding methods for String encoders.

Version:

$Id: StringEncoder.html 889935 2013-12-11 05:05:13Z ggregory $

Method Summary

String

encode(String source) Encodes a String and returns a String.

Methods inherited from interface org.apache.commons.codec.Encoder

encode

Method Detail

encode

String encode(String source)
              throws EncoderException

Encodes a String and returns a String.

Parameters:

source - the String to encode

Returns:

the encoded String

Throws:

EncoderException - thrown if there is an error condition during the encoding process.