org.apache.commons.codec
Interface StringEncoder

All Superinterfaces:

Encoder

All Known Implementing Classes:

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: 3.0 $ $Date: 2004/07/24 13:22:03 $

Author:

tobrien@transolutions.net

Method Summary

String

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

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

encode

Method Detail

encode

String encode(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.