org.apache.commons.codec
Interface StringEncoder

All Superinterfaces:

Encoder

All Known Implementing Classes:

Metaphone, RefinedSoundex, Soundex

public interface StringEncoder

extends Encoder

A StringEncoder is an encoder which expects a String as a method parameter and one that produces a String as the output of the Encoding process.

Version:

$Revision: 1.1 $ $Date: 2003/04/25 17:50:56 $

Author:

tobrien@transolutions.net

Method Summary

java.lang.String

encode(java.lang.String pString) Encode a String and produce a String.

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

encode

Method Detail

encode

public java.lang.String encode(java.lang.String pString)
                        throws EncoderException

Encode a String and produce a String.

Parameters:

pString - a String to encode

Returns:

the encoded String

Throws:

EncoderException - thrown if there is an error conidition during the Encoding process.